HP | SN6000 | Command Reference Guide | HP SN6000 Command Reference Guide

53-1003108-01
12 December 2013
Fabric OS
Command Reference
Supporting Fabric OS v7.2.1
®
Copyright © 2013 Brocade Communications Systems, Inc. All Rights Reserved.
ADX, AnyIO, Brocade, Brocade Assurance, the B-wing symbol, DCX, Fabric OS, ICX, MLX, MyBrocade, OpenScript, VCS, VDX, and
Vyatta are registered trademarks, and HyperEdge, The Effortless Network, and The On-Demand Data Center are trademarks of
Brocade Communications Systems, Inc., in the United States and/or in other countries. Other brands, products, or service names
mentioned may be trademarks 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
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
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 5640
Fax: +41 22 799 5641
E-mail: emea-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
Fax: +8620 3891 2111
E-mail: china-info@brocade.com
Document History
Document title
Publication number
Summary of changes
Publication date
Fabric OS Reference v2.0
53-0001487-03
September 1999
Fabric OS Reference v2.2
53-0001558-02
May 2000
Fabric OS Reference v2.3
53-0000067-02
December 2000
Fabric OS Reference v3.0
53-0000127-03
July 2001
Fabric OS Reference v2.6
53-0000194-02
December 2001
Fabric OS Reference v3.0 / v4.0
53-0000182-02
March 2002
Fabric OS Reference v4.0.2
53-0000182-03
September 2002
Fabric OS Reference v3.1.0
53-0000500-02
April 2003
Fabric OS Reference v4.1.0
53-0000519-02
April 2003
Fabric OS Reference v4.1.2
53-0000519-03
May 2003
Fabric OS Reference v4.1.2
53-0000519-04
July 2003
Document title
Publication number
Summary of changes
Publication date
Fabric OS Reference v4.1.2
53-0000519-05
August 2003
Fabric OS Reference v4.1.2
53-0000519-06
October 2003
Fabric OS Reference v4.2.0
53-0000519-07
December 2003
Fabric OS Command Reference
53-0000519-08
March 2004
Fabric OS Command Reference
53-0000519-08 Rev. A
April 2004
Fabric OS Command Reference
53-0000519-09
September 2004
Fabric OS Command Reference
53-0000519-10
April 2005
Fabric OS Command Reference
53-0000519-12
July 2005
Fabric OS Command Reference
53-1000240-01
September 2006
Fabric OS Command Reference
53-1000436-01
June 2007
Fabric OS Command Reference
53-1000599-01
Added 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.
October 2007
Fabric OS Command Reference
53-1000599-02
Added 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.
March 2008
Fabric OS Command Reference
53-1000599-03
Corrections and updates to 31
commands. Removed
“Brocade Optional Features”
from Preface. Added
trademark note to Preface.
Cosmetic edits throughout.
July 2008
Fabric OS Command Reference
53-1001115-01
Added 3 new commands to
support Encryption. Modified 1
command. Updated Preface
and RBAC/AD table.
August 2008
Document title
Publication number
Summary of changes
Publication date
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.
November 2008
Fabric OS Command Reference
53-1001337-01
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. Updated Preface,
surrounding chapters, and
permission tables.
July 2009
Fabric OS Command Reference
53-1001754-01
Updated 4 help pages with
new command options.
Modified 16 help pages for
minor updates and
corrections.
January 2010
Fabric OS Command Reference
53-1001764-01
Added 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.
March 2010
Fabric OS Command Reference
53-1002147-01
Added 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.
April 2011
Document title
Publication number
Summary of changes
Publication date
Fabric OS Command Reference
53-1002447-01
Added 2 new commands.
Modified 19 commands to
support Fabric OS v7.0.1
features. Removed 1
command. Updated Preface,
surrounding chapters, and
permission tables.
December 2011
Fabric OS Command Reference
53-1002746-01
Added 7 new commands.
Modified 100 commands to
support Fabric OS v7.1.0
features. Removed 6
commands. Updated Preface,
surrounding chapters, and
permission tables.
December 2012
Fabric OS Command Reference
53-1002746-02
Corrections and updates to 25
commands.
March 2013
Fabric OS Command Reference
53-1002921-01
Added 13 new commands.
Modified 75 commands to
support Fabric OS v7.2.0
features. Removed 3
commands. Updated Preface,
surrounding chapters, and
permission tables.
July 2013
Fabric OS Command Reference
53-1002921-02
Updated 13 commands and
changed the name of one
command. Updated Preface
and permission tables.
September 2013
Fabric OS Command Reference
53-1003108-01
Updated 18 commands.
Updated Preface and
permission tables.
December 2013
Contents
About This Document
How this document is organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Supported hardware and software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
What is new in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxii
New commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
Modified commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Deprecated commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
CLI usage conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Document conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Text formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Command syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Notes, cautions, and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Key terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Notice to the reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxv
Additional information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Brocade resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Other industry resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Getting technical help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Document feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvii
Chapter 1
Using Fabric OS Commands
Using the command line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Understanding Role-Based Access Control. . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Encryption commands and permissions . . . . . . . . . . . . . . . . . . . . . . . . . 2
Understanding Virtual Fabric restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Understanding Admin Domain restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Determining RBAC permissions for a specific command. . . . . . . . . . . . . . . . . 4
Chapter 2
Fabric OS Commands
aaaConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
ad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
agAutoMapBalance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Fabric OS Command Reference
53-1003108-01
vii
agShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
aliAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
aliCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
aliDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
aliRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
aliShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
appLoginHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
aptPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
auditCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
auditDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
authUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
bannerSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
bannerShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
bcastShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
bladeCfgGeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
bladeDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
bladeEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
bladeSwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
bootLunCfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
bottleneckMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
bpPortLoopbackTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
bpTurboRamTest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
bufOpMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ceePortLedTest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ceePortLoopbackTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
ceeTurboRamTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
cfgActvShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
cfgAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
cfgClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
cfgCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
cfgDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
cfgDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
cfgEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
cfgRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
cfgSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
cfgShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
cfgSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
viii
Fabric OS Command Reference
53-1003108-01
cfgTransAbort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
cfgTransShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
chassisBeacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
chassisCfgPerrThreshold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
chassisDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
chassisDistribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
chassisEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
chassisName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
chassisShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
classConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
cliHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
cmsh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
configDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
configDownload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
configList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
configRemove. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
configShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
configUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
configureChassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
creditRecovMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
cryptoCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
dataTypeShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
dbgShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
defZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
diagClearError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
diagDisablePost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
diagEnablePost. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
diagHelp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
diagPost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
diagRetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
diagShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
distribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
dlsReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
dlsSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
dlsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Fabric OS Command Reference
53-1003108-01
ix
dnsConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
enclosureShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
errClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
errDelimiterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
errDump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
errFilterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
errModuleShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
errShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
fabRetryShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
fabRetryStats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
fabricLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
fabricName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
fabricPrincipal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
fabricShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
fabStatsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
fanDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
fanEnable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
fanShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
faPwwn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
fastBoot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
fcipHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
fcipLedTest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
fcipPathTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
fcoe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
fcoeLoginCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
fcoeLoginGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
fcPing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
fcpLogClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
fcpLogDisable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
fcpLogEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
fcpLogShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
fcpProbeShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
fcpRlsProbe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
fcpRlsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
fcrBcastConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
fcrConfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
x
Fabric OS Command Reference
53-1003108-01
fcrEdgeShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
fcrFabricShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
fcrIclPathBWMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
fcrLsan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
fcrLsanCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
fcrLsanMatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
fcrPhyDevShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
fcrProxyConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
fcrProxyDevShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
fcrResourceShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
fcrRouterPortCost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
fcrRouteShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
fcrXlateConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
fddCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
fdmiCacheShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
fdmiShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
ficonCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
ficonClear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
ficonCupSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
ficonCupShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
ficonHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
ficonShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
fipsCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
firmwareCommit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
firmwareDownload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
firmwareDownloadStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
firmwareKeyShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
firmwareRestore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
firmwareShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
fmMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
fosConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
fosExec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
frameLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
fspfShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
fwAlarmsFilterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
fwAlarmsFilterShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Fabric OS Command Reference
53-1003108-01
xi
fwClassInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
fwConfigReload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
fwFruCfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
fwHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
fwMailCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
fwPortDetailShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
fwSamShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
fwSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
fwSetToCustom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
fwSetToDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
gePortErrShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
haDisable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
haDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
haEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
haFailover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
haShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
haSyncStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
haSyncStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
historyLastShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
historyMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
historyShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
iclCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
ifModeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
ifModeShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
iflShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
interfaceShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
iodReset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
iodSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
iodShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
ipAddrSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
ipAddrShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
ipFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
ipSecConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
islShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
xii
Fabric OS Command Reference
53-1003108-01
itemList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
killTelnet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
ldapCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
lfCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
licenseAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
licenseIdShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
licensePort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
licenseRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
licenseShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
licenseSlotCfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
linkCost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
logicalGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
lsanZoneShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
lsCfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
lsDbShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
mapsConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
mapsDb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
mapsHelp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
mapsPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
mapsRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
mapsSam. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
memShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
motd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
msCapabilityShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
msConfigure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
msPlatShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
msPlatShowDBCB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
msPlClearDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
msPlMgmtActivate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
msPlMgmtDeactivate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
msTdDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
msTdEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
msTdReadConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
myId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
nbrStateShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Fabric OS Command Reference
53-1003108-01
xiii
nbrStatsClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
nodeFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
nsAliasShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
nsAllShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
nsCamShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
nsDevLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
nsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
nsZoneMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
nsZoneShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
passwd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
passwdCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
pathInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
pdShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
perfAddEEMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
perfCfgClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
perfCfgRestore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
perfCfgSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
perfClearAlpaCrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
perfDelEEMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
perfHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
perfMonitorClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
perfMonitorShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
perfResourceShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
perfSetPortEEMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
perfShowAlpaCrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
perfShowPortEEMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
perfTTmon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
portAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
portAlpaShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
portBeacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
portBufferCalc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
portBufferShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
portCamShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
portCfg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
portCfgAlpa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
portCfgAutoDisable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
portCfgCompress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
xiv
Fabric OS Command Reference
53-1003108-01
portCfgCreditRecovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
portCfgDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
portCfgDPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
portCfgEncrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
portCfgEport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
portCfgEportCredits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
portCfgEXPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
portCfgFaultDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
portCfgFec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
portCfgFillword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
portCfgFportBuffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
portCfgGeMediaType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
portCfgGport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
portCfgISLMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
portCfgLongDistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
portCfgLossTov . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
portCfgLport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
portCfgNPIVPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
portCfgNPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
portCfgOctetSpeedCombo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
portCfgPersistentDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
portCfgPersistentEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
portCfgQoS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
portCfgShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
portCfgSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
portCfgTrunkPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
portCfgVEXPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
portCmd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
portDebug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
portDecom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
portDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
portDPortTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
portEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
portEncCompShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
portErrShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
portFencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
portFlagsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Fabric OS Command Reference
53-1003108-01
xv
portLedTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
portLogClear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
portLogConfigShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
portLogDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
portLogDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
portLogDumpPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
portLogEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
portLogEventShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
portLoginShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
portLogPdisc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
portLogReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
portLogResize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
portLogShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
portLogShowPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
portLogTypeDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
portLogTypeEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
portLoopbackTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
portMirror. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
portName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
portPerfShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
portRouteShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
portShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
portStats64Show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
portStatsClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
portStatsShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
portSwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
portSwapDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
portSwapEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
portSwapShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
portTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
portTestShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
portThConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
portTrunkArea. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
portZoneShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
powerOffListSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
powerOffListShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
psShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
xvi
Fabric OS Command Reference
53-1003108-01
rasAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
rasMan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
relayConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
roleConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
routeHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
rtLogTrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
secActiveSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
secAuthSecret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
secCertUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
secDefineSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
secGlobalShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
secHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
secPolicyAbort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
secPolicyActivate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
secPolicyAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
secPolicyCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
secPolicyDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
secPolicyDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
secPolicyFCSMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
secPolicyRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
secPolicySave. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
secPolicyShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
secStatsReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
secStatsShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
sensorShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
serDesTuneMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
setContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
setDbg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
setVerbose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
sfpShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
shellFlowControlDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
shellFlowControlEnable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
slotPowerOff. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
slotPowerOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
slotShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
snmpConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Fabric OS Command Reference
53-1003108-01
xvii
snmpTraps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
spinFab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
sshUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042
statsClear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1047
stopPortTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
supportFfdc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
supportFtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
supportSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
supportShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
supportShowCfgDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
supportShowCfgEnable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
supportShowCfgShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
switchBeacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
switchCfgPersistentDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067
switchCfgPersistentEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068
switchCfgSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
switchCfgTrunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
switchDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
switchEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
switchName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
switchShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
switchStatusPolicySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
switchStatusPolicyShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
switchStatusShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
switchUptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095
switchViolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
syslogdFacility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
syslogdIpAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
syslogdIpRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
syslogdIpShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
sysMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
sysShutDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1108
tempShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110
thConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1111
thMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
timeOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
topologyShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1122
xviii
Fabric OS Command Reference
53-1003108-01
traceDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
trunkDebug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
trunkShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
tsClockServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
tsTimeZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
turboRamTest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
upTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
uRouteShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
usbStorage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
userConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1152
wwn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
wwnAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
zone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
zoneAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
zoneCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171
zoneDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
zoneHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
zoneObjectCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175
zoneObjectExpunge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
zoneObjectRename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1178
zoneObjectReplace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179
zoneRemove. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1180
zoneShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1182
Chapter 3
Primary FCS Commands
Primary FCS commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
Appendix A
Command Availability
Command validation checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
Command Admin Domain and Virtual Fabrics restrictions . . . . . . . . . . . . 1188
Fabric OS Command Reference
53-1003108-01
xix
xx
Fabric OS Command Reference
53-1003108-01
About This Document
How this document is organized
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.2.1. Table 1 lists the hardware platforms supported in the Fabric OS v7.2.1 release. ASIC names
may be used in this document to distinguish between types of switches that share certain
characteristics.
TABLE 1
Supported hardware for Fabric OS v7.2.1
Hardware platform
Description
ASIC
Brocade 300
8 Gbit 16-port switch
Goldeneye 2
Brocade 5100
8 Gbit 32-port switch
Condor 2
Brocade 5300
8 Gbit 64-port switch
Goldeneye 2
Brocade 5410
8 Gbit 12-port embedded switch
Goldeneye 2
Brocade 5424
8 Gbit 24-port embedded switch
Goldeneye 2
Brocade 5431
8 Gbit 16-port stackable switch module
GoldenEye 2
Brocade 5450
8 Gbit 24-port embedded switch
Goldeneye 2
Brocade 5460
8 Gbit 24-port embedded switch
Goldeneye 2
Brocade 5470
8 Gbit 16-port embedded switch
Goldeneye 2
Brocade 5480
8 Gbit 24-port embedded switch
Goldeneye 2
Brocade 6505
16 Gbit 24-port switch
Condor 3
Brocade M6505
16 Gbit 24-port embedded switch
Condor 3
Fabric OS Command Reference
53-1003108-01
xxi
TABLE 1
Supported hardware for Fabric OS v7.2.1 (Continued)
Hardware platform
Description
ASIC
Brocade 6510
16 Gbit 48-port switch
Condor 3
Brocade 6520
16 Gbit 96-port switch
Condor 3
Brocade 6547
16 Gbit 48-port embedded switch
Condor 3
Brocade VA-40FC
8 Gbit 40-port switch
Condor 2
Brocade 7800 Extension switch 8 Gbit 16-FC ports, 6 GbE ports
Goldeneye 2
Brocade Encryption Switch
8 Gbit 16-port encryption switch
Condor 2
DCX Backbone
DCX-4S Backbone
• FC8-16 port blade
• FC8-32 port blade
• FC8-48 port blade
• FC8-64 port blade
• FCOE10-24 DCX blade
• FS8-18 Encryption blade
• FX8-24 Extension blade*
8 Gbit 512-port core fabric backbone
8 Gbit 192-port core fabric backbone
• 8 Gbit 16-port blade
• 8 Gbit 32-port blade
• 8 Gbit 48-port blade
• 8 Gbit 64-port blade
• 8 Gbit 24-port blade
• 8 Gbit 16-port encryption blade
• 8 Gbit 12-FC ports, 10 GbE ports, 2 10GbE ports
Condor 2
Condor 2
• Condor 2
• Condor 2
• Condor 2
• Condor 2
• Anvil/Condor 2
• Condor 2
• Condor 2
Brocade DCX 8510-8 backbone
Brocade DCX 8510-4 backbone
• FC8-32E port blade
• FC8-48E port blade
• FC8-64 port blade
• FC16-32 port blade
• FC16-48 port blade
• FS8-18 Encryption blade
• FX8-24 Extension blade
16 Gbit 192-port core fabric backbone
16 Gbit 384-port core fabric backbone
• 8 Gbit 32-port blade
• 8 Gbit 48-port blade
• 8 Gbit 64-port blade
• 16 Gbit 32-port blade
• 16 Gbit 48-port blade
• 8 Gbit 16-port encryption blade
• 8 Gbit 12-FC ports, 10 GbE ports, 2 10GbE ports
Condor 3
Condor 3
• Condor 3
• Condor 3
• Condor 2
• Condor 3
• Condor 3
• Condor 2
• Condor 2
Although Brocade supports and tests many different software and hardware configurations for
Fabric OS v7.2.1, documenting all possible configurations and scenarios is beyond the scope of this
document.
This document is specific to Fabric OS v7.2.1. To obtain information about an OS version other than
v7.2.1, refer to the documentation for that OS version.
What is new in this document
The Fabric OS Command Reference v7.2.1 supports the current Fabric OS release and the new
hardware platforms.
The Admin Domain and Virtual Fabric restrictions for Fabric OS commands table in the appendix
has been updated. The table lists the Admin domain, Context and Switch type for the commands.
New commands
There are no new commands introduced in release v7.2.1.
xxii
Fabric OS Command Reference
53-1003108-01
Modified commands
The following commands and associated man pages have been corrected or updated with
additional information:
•
•
•
•
•
•
•
•
•
•
•
authUtil - Included the support for SHA 256 hash type.
cryptoCfg - Included new sub-option --delete –stale_dek.
fipsCfg - Included the support for DH and SHA 256 hash type.
flow - Updated the mirror operand to specify that 256 frames per second are mirrored.
mapsRule - The maximum size of a MAPS rule is increased from 32 to 40.
mapsSam - Included the TF (F_Trunk ports) to suppported port types.
motd - Added a note to specify the Fabric OS does not control when the MOTD displays.
portCfgDPort - Included support for 8Gb LWL/ELWL FC SFPs of portcfgdport.
portCfgFaultDelay - Included DWDM mode examples.
portDPortTest - Included D_Port cable distance for different port types
portStats64Show - New counters to detect the number of FEC corrected and uncorrected
errors.
• portStatsShow- New counters to detect the number of FEC corrected and uncorrected errors.
• snmpConfig - Included the mibcapability parameters with a note that it is for restricted usage
only.
• snmpTraps - Included the mibcapability traps with a note that it is for restricted usage only.
• spinFab - This command supports a maximum of 16 paths to a single remote domain.
• thConfig - The EE class parameters are represented in kiloBytes.
Deprecated commands
There are no commands deprecated in v7.2.1.
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.
• 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.
Fabric OS Command Reference
53-1003108-01
xxiii
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 text
Identifies command names
Identifies GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
italic text
Provides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
code text
Identifies CLI output
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:
command
Commands are printed in bold.
--option, option
Command options are printed in bold.
-argument, arg
Arguments are printed in bold.
[]
Optional element.
variable
Variables are printed in italics. In the help pages, values are underlined or
enclosed in angle brackets < >.
...
Repeat the previous element, for example “member[;member...]”
value
Fixed (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.
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.
xxiv
Fabric OS Command Reference
53-1003108-01
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
ATTENTION
An Attention statement indicates potential damage to hardware or data.
CAUTION
A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.
DANGER
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.
Corporation
Referenced Trademarks and Products
Commvault
Commvault Galaxy Data Protection
EMC
RSA Data Protection Manager (DPM)
HP
Secure Key Manager (SKM) and Enterprise Secure Key Manager
(ESKM)
IBM
Tivoli Key Lifecycle Manager
Legato
Legato Networker
Microsoft Corporation
Windows, Windows NT, Internet Explorer
NetApp
NetApp Lifetime Key Manager (LKM)
Fabric OS Command Reference
53-1003108-01
xxv
Corporation
Referenced Trademarks and Products
Oracle Corporation
Oracle, Java
Symantec
Veritas NetBackup 6.5 Enterprise Server
Red Hat, Inc.
Linux
Thales
Thales 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:
http://www.brocade.com/products-solutions/products/index.page
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
xxvi
Fabric OS Command Reference
53-1003108-01
•
•
•
•
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
• 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:
• Brocade 300, 5100, 5300, 6505, M6505, 6520, 6547, 7800, VA-40FC, and Brocade
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.
• Brocade 6510—On the pull-out tab on the front of the switch.
• 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.
Fabric OS Command Reference
53-1003108-01
xxvii
xxviii
Fabric OS Command Reference
53-1003108-01
Chapter
Using Fabric OS Commands
1
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
Understanding Role-Based Access Control
Fabric OS implements Role-Based Access Control (RBAC) to control access to all Fabric OS
operations.
Eight predefined roles are supported, as described in Table 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 2
Role definitions
Role name
Definition
User
Non-administrative use, such as monitoring system activity. In Fabric
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.
Operator
A subset of administrative tasks typically required for routine
maintenance operations.
SwitchAdmin
Administrative use excluding security, user management, and zoning.
Fabric OS Command Reference
53-1003108-01
1
1
Understanding Role-Based Access Control
TABLE 2
Role definitions (Continued)
Role name
Definition
ZoneAdmin
Zone management only.
FabricAdmin
Administrative use excluding user management and Admin Domain
management.
BasicSwitchAdmin
A subset of administrative tasks, typically of a more limited scope and
effect.
Admin
All administrative tasks, including encryption and chassis commands.
SecurityAdmin
Administrative use including admin, encryption, security, user
management, and zoning.
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”.
NOTE
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.
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.
Create and register recovery share.
Encryption group and clustering-related operations.
Manage keys, including creation, recovery, and archiving functions.
• Admin and FabricAdmin
Users authenticated with the Admin and FabricAdmin RBAC roles may perform routine
encryption switch management functions including the following:
•
•
•
2
Configure virtual devices and crypto LUN.
Configure LUN/tape associations.
Perform re-keying operations.
Fabric OS Command Reference
53-1003108-01
Understanding Virtual Fabric restrictions
•
•
1
Perform firmware download.
Perform regular Fabric OS management functions.
For a listing of RBAC permissions for cryptoCfg subcommands, refer to the Fabric OS Encryption
Adminsitrator’s Guide.
Understanding Virtual Fabric restrictions
All Fabric OS commands are subject to additional RBAC enforcement with regard to Virtual Fabric
contexts and switch types. Commands can be executed in one or more of the contexts described in
Table 3. Execution of chassis commands requires chassis permissions.
TABLE 3
Virtual Fabric contexts
Context type
Definition
Switch context
Command applies to the current logical switch only, or to a specified
logical switch.
Chassis context
Command applies to the chassis on which it is executed.
Switch and chassis
context
Command can be executed in a logical switch context or in a chassis
context.
Disallowed
Command is not supported in Virtual Fabric mode.
Switch commands are further defined by the switch type restrictions as described in Table 4.
Switch type restrictions are not applicable to commands that require chassis permissions.
TABLE 4
Switch types
Switch type
Definition
All Switches
Command can be executed in any switch context.
Base Switch Only
Command can be executed only on the base switch.
Default Switch Only
Command can be executed only on the default switch.
N/A
Command is a chassis command or not supported in Virtual Fabric
mode.
In a Virtual Fabric environment where contexts are enforced, the following Virtual Fabric restrictions
apply to the RBAC permissions specified in Table 2. Refer to the userConfig command for more
information on configuring user account access permissions in a Virtual Fabric environment.
• Any given role is allowed to execute all switch commands to which the role is authorized in the
account’s home context. The default home context is the default logical fabric FID 128.
• You can change an account’s home context to a specified FID and configure the account
permissions to access additional logical switches specified in the user’s Fabric ID list.
• Accounts with user or admin permissions can be granted chassis permissions. A user account
with the chassis role can execute chassis-level commands at the user RBAC access level. An
admin account with the chassis role can execute chassis-level commands at the admin RBAC
access level.
Use the classConfig --showcli command to look up the Virtual Fabrics context for a specified
command. Refer to Appendix A, “Command Availability,” for a complete listing of Virtual Fabric
restrictions that apply to the commands included in this manual.
Fabric OS Command Reference
53-1003108-01
3
1
Understanding Admin Domain restrictions
Understanding Admin Domain restrictions
A subset of Fabric OS commands is subject to Admin Domain (AD) 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 in to that Admin Domain.
Six Admin Domain types are supported, as defined in Table 5.
TABLE 5
AD types
AD Type
Definition
Allowed
Allowed to execute in all ADs.
PhysFabricOnly
Allowed to execute only in AD255 context (and the user should own
access to AD0-AD255 and have admin RBAC privilege).
Disallowed
Allowed to execute only in AD0 or AD255 context; not allowed in
AD1-AD254 context.
PortMember
All control operations 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.
AD0Disallowed
Allowed to execute only in AD255 and AD0 (if no ADs are configured).
AD0Only
Allowed 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.
Determining RBAC permissions for a specific command
To determine RBAC permission for a specific command, use the classconfig --showcli command.
1. Enter the classconfig --showcli command for a specified command.
The command displays the RBAC class and access permissions for each of the command
options. Note that options for a single command option can belong to different classes.
2. Enter the classconfig --showroles command and specify the RBAC class of the command
option you want to look up.
The command displays the default roles and the permissions they have to access commands
in the specified RBAC class.
The following example shows how you can obtain permission information for the zone command.
Suppose you want to know if a user with the SwitchAdmin role can create a zone. You issue the
classconfig --showcli command for the zone command, which shows that the zone --add command
belongs to the RBAC class “zoning”. You then issue the classconfig --showroles command for the
zoning RBAC class. The output shows that the SwitchAdmin role has ‘Observe” (O) permissions only
for any command in the zoning class. This means that the user with the SwitchAdmin role is not
allowed to create zones. To allow this user to create a zone, you must change the user’s access to
any of the roles that have “observe and modify” (OM) access. Use the userConfig command to
change the user’s role or use the roleConfig command to create a custom role.
4
Fabric OS Command Reference
53-1003108-01
Determining RBAC permissions for a specific command
1
switch:admin> classconfig --showcli zone
CLI
Option
Permission RBAC Class
Context
---------------------------------------------------------zone
Killall
OM
Debug
vf
zone
evlogclear
OM
Debug
vf
zone
evlogshow
O
Debug
vf
zone
evlogtoggle
OM
Debug
vf
zone
mergeshow
O
Debug
vf
zone
stateshow
O
Debug
vf
zone
activate
OM
Zoning
vf
zone
add
OM
Zoning
vf
zone
copy
OM
Zoning
vf
zone
create
OM
Zoning
vf
zone
deactivate
OM
Zoning
vf
(output truncated)
switch:admin> classconfig --showroles zoning
Roles that have access to the RBAC Class 'zoning' are:
Role Name
--------User
Admin
Factory
Root
Operator
SwitchAdmin
ZoneAdmin
FabricAdmin
BasicSwitchAdmin
SecurityAdmin
Permission
---------O
OM
OM
OM
O
O
OM
OM
O
O
NOTE
If a Role Name does not appear in the list, it indicates that the role is not available to the
specified class and associated commands in that class are restricted and cannot be executed
in that role.
Fabric OS Command Reference
53-1003108-01
5
1
6
Determining RBAC permissions for a specific command
Fabric OS Command Reference
53-1003108-01
Chapter
Fabric OS Commands
2
aaaConfig
Manages RADIUS, LDAP, and TACACS+ configuration information.
SYNOPSIS
aaaconfig
aaaconfig --show
aaaconfig --add | --change server -conf radius | ldap | tacacs+
[-p port] [-d domain] [-t timeout] [-s secret]
[-a chap | pap | peap-mschapv2]
aaaconfig --remove server -conf radius | ldap | tacacs+
aaaconfig --move server -conf radius | ldap | tacacs+ to_position
aaaconfig --authspec aaa1[;aaa2 [-backup] [-nologout]
aaaconfig --help
DESCRIPTION
Use this command to manage the RADIUS, LDAP, and TACACS+ server configuration for the
authentication, authorization and accounting (AAA) services. Use this command to display, add, remove,
change, enable or disable the RADIUS, LDAP, or TACACS+ configuration.
Brocade switches use a local as well as a remote authentication mechanism for validating a login.
Supported authentication protocols include Password Authentication Protocol (PAP),
Challenge-Handshake Authentication Protocol (CHAP) and Protected Extensible Authentication Protocol
(PEAP). In addition, Fabric OS v6.0.0 and later provides support for Light-weight Directory Access
Protocol (LDAP) authentication against Active Directory for user authentication and authorization.
RADIUS, LDAP or TACACS+ servers are contacted in the order they appear in the configuration list. The
first server returning authentication success or failure causes the authentication request to succeed or
fail. If no response is received within the specified timeout, the next RADIUS, LDAP, or TACACS+ server
in the list is contacted. An event entry logs if all RADIUS, LDAP, or TACACS+ servers fail to respond.
When the command succeeds, it triggers an event log (the Fabric OS error log) to indicate a server is
added, removed, or modified. Refer to the Fabric OS Message Reference manual for specific details.
There are two modes of operation in LDAP authentication, FIPS mode and non-FIPS mode. However,
there is no option to configure LDAP while the switch is in FIPS mode. The LDAP client checks if FIPS
mode is set on the switch and uses FIPS-compliant TLS ciphers for LDAP. If FIPS mode is not set and
the ADir server is configured for FIPS ciphers, it uses FIPS-compliant ciphers.
Configuration changes are persistently saved and take effect with the next AAA request. The
configuration applies to all switch instances in a platform supporting multiple switch domains.
NOTES
Customers can use centralized RADIUS servers to manage AAA services for a switch, as defined in the
RFC 2865 RADIUS specification.
This command can be executed when logged in through the console, Telnet or SSH connection.
Fabric OS Command Reference
53-1003108-01
7
2
aaaConfig
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
server
Specifies an IP address or a server name in dot-decimal notation. IPv6 addresses
are supported. If a name is used, a DNS entry must be correctly configured for the
server. If the specified server IP address or name already exists in the current
configuration, the command fails and generates an error. However, the command
does not validate the server name against the IP address in the configuration.
Make sure to avoid duplicate configuration of the same server, one specified by
the name, the other specified by the IP address.
--show
Displays the current AAA service configuration.
--add | --change server [options]
Adds or modifies a RADIUS, LDAP, or TACACS+ server. The --add option
appends the specified server to the end of the current configuration list. A
maximum of 5 servers are supported for each authentication type. The --change
option modifies the specified server configuration to use the new arguments. The
server must be one of the IP addresses or names shown in the current
configuration.
The following options are supported:
-conf radius | ldap | tacacs+
Specifies the server configuration as either RADIUS, LDAP, or TACACS+. This
operand is required.
The following operands are optional:
-p port
Specifies the RADIUS, LDAP, or TACACS+ server port number. Supported
range is 1 to 65535. The default port is 1812 for RADIUS authentication. The
default port is 1813 for RADIUS accounting. The default port is 389 for LDAP
authentication. The default port is 49 for TACACS+ authentication. This
operand is optional. If no port is specified, the default is used.
-t timeout
Specifies the response timeout for the RADIUS, the LDAP or the TACACS+
server. The supported range is 1 to 30 seconds. The default is 3 seconds.
This operand is optional. If no timeout is specified, the default is used.
-d domain
Specifies the Windows domain name for the LDAP server, for example,
brocade.com. This option is valid only with the -conf ldap option. This
operand is required.
-s secret
Specifies a common secret between the switch and the RADIUS or
TACACS+ server. The secret must be 8 to 40 characters for RADIUS server,
and 1 to 40 characters for TACACS+ server. This option is valid only with
-conf radius or -conf tacacs+options, and it is optional. The default value is
sharedsecret.
-a
Specifies the remote authentication protocol for the RADIUS or TACACS+
server. This operand is valid with -conf radius or -conf tacacs+ options,
and it is optional. The default value for this operand is CHAP.
8
Fabric OS Command Reference
53-1003108-01
aaaConfig
2
Note that the distinction between protocols is only applicable to the packets
between a system and the RADIUS or TACACS+ server. To authenticate a
user to the system, a password is always used.
Valid protocols are one of the following:
pap
Password Authentication Protocol
chap
Challenge-Handshake Authentication Protocol
peap-mschapv2
Protected Extensible Authentication Protocol (requires Fabric OS v5.3.0 or
later). This is applicable only to RADIUS configuration.
--remove server
Removes the specified server from the configuration. The server must match one
of the IP addresses or the names shown in the current configuration. The
following operand is required:
-conf radius | ldap | tacacs+
Specifies the server configuration as either RADIUS, LDAP, or TACACS+. If the
server is enabled, the command does not allow the last server to be removed from
the configuration list. RADIUS, LDAP, or TACACS+ must first be disabled before
the last server of the specified type may be removed.
--move server option
Moves the specified server from the current position in a RADIUS, LDAP, or
TACACS+ configuration list to the specified position. If the specified position is the
same as the current position, no change takes place. Valid options include the
following:
-conf radius | ldap | tacacs+
Specifies the server configuration as RADIUS, LDAP, or TACACS+. This operand
is required.
to_position
Specifies the new position for the server. The value for to_position is an integer,
and must be within the range of server positions in the current configuration. Use
the --show option to determine current server positions. This operand is required.
--authspec "aaa1[;aaa2" [-backup] [-nologout]
Replaces the configuration with the specified AAA service. Each service can be
specified only once in the list, for example, "radius; local; radius" is invalid. No edit
option is provided. The --authspec option takes as an argument a
semicolon-separated list of AAA services. Services must be enclosed in double
quotation marks.
The following AAA services and service pairs are valid:
"local"
Default setting. Authenticates the user against the local database only. If the
password does not match or the user is not defined, the login fails.
"radius"
When "radius" is specified, the first RADIUS server is contacted. If the RADIUS
server is not reachable, the next RADIUS server is contacted. If the authentication
fails, the authentication process does not check for the next server in the
sequence.
Fabric OS Command Reference
53-1003108-01
9
2
aaaConfig
"ldap"
When "ldap" is specified, the first Active directory (AD) server is contacted. If the
AD server is not reachable, the next AD server is contacted. If the authentication
fails, the authentication process does not check for the next server in the
sequence.
"tacacs+"
When "tacacs+" is specified, the first Active directory (AD) server is contacted. If
the AD server is not reachable, the next AD server is contacted. If the
authentication fails, the authentication process does not check for the next server
in the sequence.
"radius;local"
Enables the current RADIUS configuration as the primary AAA service and the
switch-local database as the secondary AAA service. If "radius" and "local" are
specified, and if the RADIUS servers are reachable and the user credentials are
correct, the user authentication succeeds. If the user provides credentials from the
switch database, the RADIUS authentication fails but login succeeds through the
switch database.
"ldap;local"
Enables the current LDAP configuration as the primary AAA service and the
switch-local database as the secondary AAA service. If "ldap" and "local" are
specified, and if the AD servers are reachable and the user credentials are
correct, the user authentication succeeds. If the user provides credentials from the
switch database, AD authentication fails but login would still succeed through the
switch database.
"tacacs+;local"
Enables the current TACACS+ configuration as the primary AAA service and the
switch-local database as the secondary AAA service. If "tacacs+" and "local" are
specified, and if the AD servers are reachable and the user credentials are
correct, the user authentication succeeds. If the user provides credentials from the
switch database, AD authentication fails but login would still succeed through the
switch database.
-backup
For use with the "radius;local", "ldap;local", and "tacacs+;local" options only. The
backup option states to try the secondary AAA service only if none of the primary
AAA services are available.
-nologout
If -nologout is not specified, a change in the authentication mechanism may
result in the termination of existing sessions. All existing sessions are terminated if
the new authentication mechanism is one of the following: RADIUS only, LDAP
only, TACACS+ only, or Local. If -nologout is specified, there will be no effect on
the existing sessions regardless of the chosen authentication mechanism.
--help
Displays the command usage.
EXAMPLES
To display the current RADIUS, LDAP, and TACACS+ configurations:
switch:admin> aaaconfig --show
RADIUS CONFIGURATIONS
=====================
Position Server
Port Timeout(s) Auth-Protocol
1
2
3
10
192.168.233.48
192.168.233.44
radserver
1812
1812
1812
3
3
CHAP
CHAP
5
CHAP
Fabric OS Command Reference
53-1003108-01
aaaConfig
2
LDAP CONFIGURATIONS
===================
LDAP configuration does not exist.
TACACS+ CONFIGURATIONS
=====================
TACACS+ configuration does not exist.
Primary AAA Service: Switch database
Secondary AAA Service: None
To move the RADIUS server "radserver" from position 3 to position 1:
switch:admin> aaaconfig --move radserver -conf radius 1
To configure the RADIUS server 192.168.233.48 as an LDAP server:
switch:admin> aaaconfig --change 192.168.233.48
-conf ldap -p 3002 -s newsecret -t 1
\
To add an AD/LDAP server to the configuration:
switch:admin> aaaconfig --add 194.72.68.335
-conf ldap -p 3002 -d brocade.com -t 1
\
To replace the AAA service with backup option:
switch:admin> aaaconfig --authspec "ldap;local" -backup
To change the authentication mechanism with the no logout provision:
switch:admin> aaaconfig --authspec radius -nologout
switch:admin> aaaconfig --show
RADIUS CONFIGURATIONS
=====================
Position
:
Server
:
Port
:
Timeout(s)
:
Auth-Protocol:
1
172.20.1.68
1812
3
PEAP-MSCHAPv2
LDAP CONFIGURATIONS
===================
LDAP configuration does not exist.
TACACS+ CONFIGURATIONS
=====================
TACACS+ configuration does not exist.
Primary AAA Service: RADIUS
Secondary AAA Service: None
Fabric OS Command Reference
53-1003108-01
11
2
aaaConfig
To add a TACACS+ server to the configuration:
switch:admin> aaaconfig --add 10.17.56.56 -conf tacacs+ \
-protocol pap -s "sharedkey" -t 5 -r 5 -port 49
switch:admin> aaaconfig --authspec tacacs+
switch:admin> aaaconfig --show
RADIUS CONFIGURATIONS
=====================
RADIUS configuration does not exist.
LDAP CONFIGURATIONS
===================
LDAP configuration does not exist.
TACACS+ CONFIGURATIONS
=====================
Position
: 1
Server
: 10.17.56.56
Port
: 49
Retries
: 5
Timeout(s)
: 5
Auth-Protocol: PAP
Primary AAA Service: TACACS+
Secondary AAA Service: None
SEE ALSO
12
None
Fabric OS Command Reference
53-1003108-01
ad
2
ad
Manages Admin Domain operations.
SYNOPSIS
ad --activate ad_id
ad --add ad_id [-d "dev_list"] [-s "switch_list"]
ad --apply
ad --clear [-f]
ad --create ad_id [-d "dev_list"] [-s "switch_list"]
ad --deactivate ad_id
ad --delete ad_id
ad --exec ad_id "command_list"
ad --remove ad_id [-d "dev_list"] [-s "switch_list"]
ad --rename ad_id new_ad_id
ad --save
ad --select ad_id
ad --show [-i | [ad_id [-m mode]]] (in AD255 context)
ad --show [-i ] (in AD0 context)
ad --show (in AD1-254 context)
ad --validate [-i | [ad_id | [-m mode]]]
ad --transabort
ad --transshow
DESCRIPTION
Use this command to manage Admin Domain operations.
This command follows a batched-transaction model. When executed with the --activate, --add, --clear,
--create, --deactivate, --delete, --remove, --rename options, this command changes only the Defined
Configuration in the transaction buffer. The --save option sends the changes made in the transaction
buffer to all other switches and permanently saves the changes to the Defined configuration in persistent
storage. The --apply option performs a save operation, sends a request to apply the Admin Domain
configuration (as defined in the persistent storage), and then enforces the configuration locally.
The Admin Domain transaction buffer is linked to the current login shell and is lost on logout. Use the
--transshow option to display the current Admin Domain transaction information.
Fabric OS Command Reference
53-1003108-01
13
2
ad
Before creating Admin Domains, the default zone mode should be set to "No Access". To set the default
zone mode to "No Access" execute the following command sequence:
switch:admin> ad --select AD0
switch:admin> defzone --noaccess
switch:admin> cfgsave
Refer to defZone help for more information.
All switches, switch ports and devices in the fabric that are not specified in any other Admin Domain are
treated as implicit members of AD0. Members added to AD0 are called explicit members.
When a new Admin Domain is created, the members included in the new Admin Domain are
automatically removed from the implicit member list of AD0. If the devices included in the new Admin
Domain are already zoned in AD0, and if you want to move these devices from AD0 without any traffic
disruption, do the following:
NOTES
OPERANDS
1.
Add the devices to AD0's explicit member list using ad --add and ad --apply.
2.
Create new ADs with the devices and execute ad --apply.
3.
Select (or login to) the new Admin Domain and create a relevant zone configuration and zones
(Refer to zone --copy help for details). Enable the new zone configuration under the Admin Domain.
4.
(Optionally) remove explicit members from AD0 (using ad --remove and ad --apply). Remove the
member references from the AD0 zone database.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The generalized syntax for this command is "ad action arguments". Command actions are described
first. Argument details follow the description of actions.
The following actions are supported:
--activate arg
Activates an Admin Domain. An Admin Domain is enforced only if it is in an
activated state. AD0 is always in an activated state. By default, after the Admin
Domain is enabled, the devices specified in the Admin Domain are not able to see
each other until they are zoned together. The command prompts for confirmation.
The activate operation remains in the transaction buffer until you issue ad --apply
or ad --save.
--add arguments
Adds new members to an existing Admin Domain. The add operation remains in
the transaction buffer until you issue ad --apply or ad --save.
--apply
Saves the current transaction buffer contents to the defined configuration and
enforces the defined configuration on all switches in the fabric. ad --apply
prompts for confirmation.
--clear [-f]
Deletes all ADs and clears AD0's explicit members. This command fails if AD1
through AD254's zone databases are not empty. The command prompts for
confirmation before deleting all Admin Domains. The clear operation remains in
the transaction buffer until you issue ad --apply or ad --save.
When used with the -f option, this command deletes all ADs and clears all explicit
members from AD0, even if the zone databases or AD1 through AD254 are not
empty. Use the force option to remove Admin Domains before enabling Virtual
Fabrics.
14
Fabric OS Command Reference
53-1003108-01
ad
2
--create arguments
Creates a new Admin Domain with optionally specified device or switch members.
A newly created Admin Domain is in an activated state. It initially contains no zone
database. The newly created Admin Domain remains in the transaction buffer until
you issue ad --apply or ad --save. AD0 always exists. Use ad --add to add
explicit members to AD0.
--deactivate arg
Deactivates an Admin Domain. This operation fails if an effective zone
configuration exists under the Admin Domain. This operation is not allowed on
AD0. ad --deactivate does not disable any ports. Existing logins to a deactivated
Admin Domain are not terminated; however, subsequent CLI execution is
disallowed. A message is displayed to indicate that the current Admin Domain is
not active. The command prompts for confirmation. The deactivate operation
remains in the transaction buffer until you issue ad --apply or ad --save.
--delete arg
Deletes an Admin Domain. This command succeeds regardless of whether the
Admin Domain is in a deactivated or an activated state. AD0 always exists; using
this operation on AD0 does not delete AD0, it only removes all explicit members
from AD0. The AD0 zone database does not need to be empty for the delete
operation to succeed. Not all existing user sessions to a deleted Admin Domain
are terminated; however, subsequent CLI execution is disallowed. A message
displays indicating that the current Admin Domain is not active. The command
prompts for confirmation before executing the delete action. The delete operation
remains in the transaction buffer until you issue ad --apply or ad --save.
--exec arguments
This command performs the following tasks:
•
•
•
•
Creates a new shell.
Executes ad --select to the specified Admin Domain.
Executes the specified commands.
Exits the shell.
--remove arguments
Removes one or more members from an Admin Domain. Removing the last
member from an Admin Domain deletes the Admin Domain. The remove
operation remains in the transaction buffer until you issue ad --apply or ad --save.
--rename arguments
Renames the specified Admin Domain. If a reserved name is used for new_ad_id
(AD number format), the operation fails if the reserved name does not correspond
to the ad_id AD number. The rename operation remains in the transaction buffer
until you issue ad --apply or ad --save.
--save
Saves the outstanding Admin Domain transaction to the defined configuration on
all switches in the fabric. The saved Admin Domain definition is enforced only
when ad --apply is issued. Attempts to modify and save an Admin Domain that is
currently enforced will fail. The command prompts for confirmation.
--select arg
Selects an Admin Domain context. This command fails if the corresponding Admin
Domain is not activated. This operation succeeds only if you have the specified
Admin Domain. This command internally spawns off a new shell within the
requested Admin Domain context. Type logout or exit to exit from the selected
Admin Domain. The zone transaction is linked to the current shell; therefore, the
zone transaction buffer is lost on logout. Use cfgTransShow to display the
current zoning transaction information.
Fabric OS Command Reference
53-1003108-01
15
2
ad
--show arguments
Displays the membership information of the specified Admin Domain or all Admin
Domains.
When executed in an AD255 context and an Admin Domain name is not specified,
all information about all existing Admin Domains is displayed. When executed in
an AD0-AD254 context, the command, by default, displays the members of the
current Admin Domain's effective configuration, and therefore you cannot specify
an ad_id or mode.
When executed in an AD255 context, all Admin Domain information from the
transaction buffer, defined configuration and effective configuration is displayed.
--validate arguments
Checks whether Admin Domain members are from a non-Admin Domain aware
switch or the members do not exist in the fabric. The output is similar to ad
--show; however, all members that are from non-Admin Domain aware switches
are marked with a plus sign (+). Members that are not online are marked with an
asterisk (*).
FC Router Front Phantom Domain and FC Router Translate Phantom Domain are
virtual entities without any exposed management interfaces; therefore, any FC
Router phantom switch WWN specified in an AD switch member list is marked as
a non-Admin Domain aware member. All D,PI members in the device list
corresponding to an FC Router Phantom Domain are marked as non-Admin
Domain aware members. All FC Router imported devices in the AD device list are
marked as AD-aware members.
--transabort
Aborts the transaction buffer. The command prompts for confirmation before
aborting the transaction.
--transshow
Displays the ID of the current Admin Domain transaction and indicates whether or
not the transaction can be aborted. The transaction cannot be aborted if it is an
internal Admin Domain transaction.
The following arguments are supported with selected AD actions:
ad_id
Uniquely identifies an Admin Domain. An ad_id can be a name or a number:
name
An Admin Domain name can be up to 63 bytes, must begin with a letter, and can
consist of letters, numbers, and underscore characters. The Admin Domain
names with the format AD[0-255] are reserved for autoassigning Admin Domain
names to Admin Domains created with an Admin Domain number. and can be
assigned only to the corresponding Admin Domain. Using ad --rename, for
example, in an attempt to assign a name of AD5 to an Admin Domain with ID not
equal to 5 fails. Admin Domain names are case-sensitive.
number
An Admin Domain can be specified by a number. Valid values include 0 through
255. AD0 and AD255 are always active. AD0 cannot be specified with --activate,
--deactivate or --delete actions. AD255 can be specified only with --exec, --show
and --validate actions.
For all command iterations, with the exception of ad --create, the Admin Domain
is specified either by a name or a number. For ad --create, both name and
number can be specified: for example, ad --create test_ad/10 -d "100,5; 100,1".
16
Fabric OS Command Reference
53-1003108-01
ad
2
-d "dev_list"
Specifies the list of devices in an Admin Domain, in quotation marks. Separate
each entry in the device list with a semicolon (;). Valid formats include the
following:
D,PI
Uses existing zone D,PI member types. Benefits include the following:
•
•
•
Grants port control and zoning on the switch port and the devices attached to
that port.
PI can be specified as a range; for example, D,[0 to 34]. The port index range
is expanded and stored internally.
The same D,PI members can be specified in more than one Admin Domain.
Device WWN
Uses traditional zone WWN member types. Benefits include the following:
•
•
•
•
Supports node or port WWNs.
End-device members, whose WWNs are used in an Admin Domain definition,
need not be online when the Admin Domain is created (similar to a
zoneCreate operation).
Provides rights to zone the devices.
Provides administrative view rights to the switch port the device is connected
to.
-s "switch_list"
Specifies the list of switches in an Admin Domain. The list must be enclosed in
quotation marks. Separate each entry in the switch list with a semicolon (;).
Specify the switch in one of the following formats:
Switch WWN
World wide name of the switch.
Domain ID
Any switch member specified in Domain ID format is converted into a switch
WWN-based on the current fabric information. Operations with switch list fail
if the domain ID to switch WWN lookup fails.
Membership in an AD switch_list grants switch administrative operations
such as switchDisable, switchEnable, reboot, ad, etc. on the switch.
Ownership of a switch implicitly provides port control capability on all its ports,
but no zoning control.
"command_list"
Specifies one or more commands to execute in an Admin Domain context. This
operand is valid only with the --exec option.
new_ad_id
Specifies a new Admin Domain name or number. This operand is valid only with
the --rename option. Format is the same as ad_id.
-i
Displays the implicit members of AD0. This operand is valid only with the --show
option.
-m mode
Specifies the mode in which Admin Domain configuration information is displayed.
This operand is valid only with --show and --validate. Valid values for mode
include the following:
0
Displays the Admin Domain configuration in the current transaction buffer.
Fabric OS Command Reference
53-1003108-01
17
2
ad
1
Displays the Admin Domain configuration stored in persistent memory
(defined configuration).
2
Displays the currently enforced Admin Domain configuration currently
enforced (effective configuration).
EXAMPLES
To enable AD5:
switch:admin> ad --activate 5
You are about to activate a new admin domain.
Do you want to activate '5' admin domain \
(yes, y, no, n): [no] y
To enable AD_13:
switch:admin> ad --activate AD_13
To add new device members to AD1:
switch:admin> ad --add AD1, -d "100,5; 4,1"
To apply all changes made to the Admin Domain configurations since --apply was last executed:
switch:admin> ad --apply
You are about to enforce the saved AD configuration.
This action will trigger ad --apply to all switches \
in the fabric.
Do you want to apply all admin domains \
(yes, y, no, n): [no] y
To clear all Admin Domain definitions:
switch:admin> ad --clear
You are about to delete all ADs definitions.
This operation will fail if zone configurations \
exists in AD1-AD254
Do you want to clear all admin domains \
(yes, y, no, n): [no] y
To create an Admin Domain with a mix of D,PI, WWNs, and zone alias device members (two different
methods shown):
switch admin> ad --create "AD1", \
-d "100,5; 1,3; 20:00:00:e0:8b:05:4d:05"
switch admin> ad --create 1, \
-d "100,5; 1,3; 21:00:00:e0:8b:05:4d:05"
To create an Admin Domain with two switches identified by domain ID and switch WWN:
switch:admin> ad --create "AD1", \
-s "100; 10:00:00:60:69:80:59:13"
To create an Admin Domain with a device list and a switch list:
switch:admin> ad --create "AD1", \
-d "100,5; 1,3; 21:20:00:00:e0:8b:05:4d:05"
-s "100; 10:00:00:60:69:80:59:13"
18
\
Fabric OS Command Reference
53-1003108-01
ad
2
To deactivate Admin Domain 5:
switch:admin> ad --deactivate 5
You are about to deactivate an AD.
This operation will fail if an effective zone \
configuration exists in the AD
Do you want to deactivate '5' admin domain \
(yes, y, no, n): [no] y
To delete AD13:
switch:admin> ad --delete 13
You are about to delete an AD.
This operation will fail if an effective zone \
configuration exists in the AD
Do you want to delete '13' admin domain \
(yes, y, no, n): [no] y
To execute switchShow in an AD7 context (using the current user_id):
switch:admin> ad --exec 7 "switchshow"
To rename Eng_AD to Eng_AD2:
switch:admin> ad --rename Eng_AD Eng_AD2
To rename AD 200 to Eng_AD200:
switch:admin> ad --rename 200 Eng_AD200
To rename a user-assigned Admin Domain name to a reserved Admin Domain name (this operation fails
if AD_test's AD number is not 200):
switch:admin> ad--rename AD_test AD200
To remove the devices 100,5 and 1,3 from AD1:
switch:admin> ad --remove "AD1", \
-d "100,5; 1,3; 21:00:00:e0:8b:05:4d:05"
To remove the switch 100 from AD1:
switch:admin> ad --remove "AD1", -s "100"
To save any outstanding Admin Domain definition-related transaction buffer
switch:admin> ad --save
You are about to save the outstanding AD membership.
This action will only save the changes to Defined \
configuration.
Any changes made will be enforced only on ad --apply.
Do you want to save admin domains \
(yes, y, no, n): [no] y
To select a new Admin Domain context by specifying the AD number:
switch:admin> ad --select 12
Fabric OS Command Reference
53-1003108-01
19
2
ad
To display all ADs:
switch:admin> ad --show
Current AD: 255 : AD255
Transaction buffer configuration:
--------------------------------no configuration
Defined configuration:
---------------------AD: 1 :
AD1
Device WWN members:
Switch port members:
Switch WWN members:
Active
21:00:00:80:e5:12:8b:37;
21:00:00:80:e5:12:8b:55;
1,0; 1,1; 1,2; 1,3; 1,4; 1,5;
1,6; 1,7; 1,8; 1,9; 1,10; 1,11;
1,12; 1,13; 1,14; 1,15;
10:00:00:60:69:00:02:53;
Effective configuration:
-----------------------AD: 1 :
AD1
Device WWN members:
Switch port members:
Switch WWN members:
Active
21:00:00:80:e5:12:8b:37;
21:00:00:80:e5:12:8b:55;
1,0; 1,1; 1,2; 1,3; 1,4; 1,5;
1,6; 1,7; 1,8; 1,9; 1,10; 1,11;
1,12; 1,13; 1,14; 1,15;
10:00:00:60:69:00:02:53;
To display the AD1 configuration information in the transaction buffer:
switch:admin> ad --show 1 -m 0
Current AD: 255 : AD255
Transaction buffer configuration:
--------------------------------no configuration
To display the AD10 configuration information in persistent storage:
switch:admin> ad --show 10 -m 1
Current AD: 255 : AD255
Defined configuration:
---------------------AD: 1 :
AD1
Device WWN members:
Switch port members:
Switch WWN members:
20
Active
21:00:00:80:e5:12:8b:37;
21:00:00:80:e5:12:8b:55;
1,0; 1,1; 1,2; 1,3; 1,4; 1,5;
1,6; 1,7; 1,8; 1,9; 1,10; 1,11;
1,12; 1,13; 1,14; 1,15;
10:00:00:60:69:00:02:53;
Fabric OS Command Reference
53-1003108-01
ad
2
To display the Admin Domain effective configuration information:
switch:admin> ad --show -m 2
Current AD: 255 : AD255
Effective configuration:
-----------------------AD: 1 :
AD1
Device WWN members:
Switch port members:
Switch WWN members:
Active
21:00:00:80:e5:12:8b:37;
21:00:00:80:e5:12:8b:55;
1,0; 1,1; 1,2; 1,3; 1,4; 1,5;
1,6; 1,7; 1,8; 1,9; 1,10; 1,11;
1,12; 1,13; 1,14; 1,15;
10:00:00:60:69:00:02:53;
To display the configuration information in the transaction buffer:
switch:admin> ad --validate
Current AD Number: 255 AD Name: AD255
Transaction buffer configuration:
--------------------------------no configuration
Defined configuration:
---------------------AD Number:
1
AD Name: AD1
Device WWN members:
State: Inactive
10:00:00:00:00:01:00:00;
10:00:00:00:00:04:00:00;
10:00:00:00:00:05:00:00;
10:00:00:00:00:06:00:00;
10:00:00:00:00:08:00:00;
10:00:00:00:00:03:00:00;
10:00:00:00:00:02:00:00;
10:00:00:00:00:07:00:00;
10:00:00:00:00:15:00:00;
10:00:00:00:00:16:00:00;
10:00:00:00:00:17:00:00;
10:00:00:00:00:18:00:00;
10:00:00:00:00:11:00:00;
10:00:00:00:00:12:00:00;
10:00:00:00:00:13:00:00;
10:00:00:00:00:14:00:00;
Effective configuration:
-----------------------AD Number:
50
AD Name: AD50
Device WWN members:
Switch port members:
Fabric OS Command Reference
53-1003108-01
State: Active
10:00:00:00:00:17:00:00;
10:00:00:00:00:15:00:00;
2,52; 2,53; 2,54; 2,55; 21,5;
3,28; 3,29; 98,72; 98,75;
69,16; 69,18; 69,21; 1,336;
21
2
ad
1,337;
---------------------------* - Member does not exist
+ - Member is AD Unaware
To abort the Admin Domain management transaction buffer:
switch:admin> ad --transabort
You are about to abort the outstanding AD transaction.
Do you want to abort the AD transaction \
(yes, y, no, n): [no] y
To display the current Admin Domain transaction:
switch:admin> ad --transshow
Current transaction token is 26816
It is abortable
switch:admin> ad --transshow
There is no outstanding zoning transaction
SEE ALSO
22
cfgSave, cfgTransShow, defZone, logout
Fabric OS Command Reference
53-1003108-01
ag
2
ag
Enables Access Gateway (AG) and manages AG-specific operations.
SYNOPSIS
ag --help
ag --show
ag --modeshow | --modeenable | --modedisable
ag [--policyenable | --policydisable] policy
ag --policyshow
ag --mapshow [N_Port]
ag [--mapset | --mapadd | --mapdel] N_Port [F_Port1; F_Port2;...]
ag [--staticadd | --staticdel ] N_Port [F_Port1; F_Port2;...]
ag --pgshow [pgid]
ag --pgcreate pgid "N_Port1 [;N_Port2;...]" [-n pgname]
[-m "lb; mfnm"]
ag [--pgadd | --pgdel] pgid "N_Port1 [; N_Port2;...]"
ag --pgrename pgid newname
ag --pgremove pgid
ag [--pgmapadd | --pgmapdel] pgid "F_Port1 [; F_Port2;...]"
ag [--pgsetmodes | --pgdelmodes] pgid "mfnm;lb"
ag --pgfnmtov [new_tov]
ag [--failoverenable | --failoverdisable] [N_Port | -pg pgid]
ag --failovershow [N_Port]
ag [--failbackenable | --failbackdisable] [N_Port | -pg pgid]
ag --failbackshow [N_Port]
ag [--prefset | --prefdel] "F_Port [;F_Port2;...]" N_Port
ag --prefshow
ag [--adsset | --adsadd | --adsdel] "F_Port [;F_Port2;...]"
"WWN [;WWN2;...]"
ag --adsshow
ag --persistentalpaenable 1 | 0 mode
Fabric OS Command Reference
53-1003108-01
23
2
ag
ag --printalpamap F_Port
ag --deletepwwnfromdb PWWN
ag --clearalpamap F_Port
ag --addwwnmapping N_Port "WWN [;WWN2;...]" | --all
ag --delwwnmapping N_Port "WWN [;WWN2;...]" | --all
ag --addwwnpgmapping Port_Group "WWN [;WWN2;...]" | --all
ag --delwwnpgmapping Port_Group "WWN [;WWN2;...]" | --all
ag --addwwnfailovermapping N_Port "WWN [;WWN2;...]" | --all
ag --delwwnfailovermapping N_Port "WWN [;WWN2;...]" | --all
ag --wwnmappingenable "WWN [;WWN2;...]" | --all
ag --wwnmappingdisable "WWN [;WWN2;...]" | --all
ag --wwnmapshow
ag --reliabilitycounterset
ag --reliabilitycountershow
ag --backupmappingsave N_Port
ag --backupmappingdel N_Port
ag --backupmappingshow N_Port
DESCRIPTION
Use this command to perform the following Access Gateway management functions:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
24
Enable or disable Access Gateway mode.
Display current configuration and state of AG.
Configure and display F_Port to N_Port mapping.
Configure and display N_Port failover and failback policies.
Configure and display Port Group policy.
Create or remove a Port group.
Enable or disable auto port configuration (APC) modes for a Port group.
Get or set timeout value for fabric name monitoring.
Display Port Groups and member N_Ports.
Add or delete N_Ports in a Port group.
Display all policies and their status.
Enable or disable auto port configuration (APC) policy.
Enable or disable preferred secondary N_Port policy.
Enable, disable, and manage advanced device security (ADS) policy.
Manage persistent ALPA mode.
Manage device WWN to N_Port mappings.
Fabric OS Command Reference
53-1003108-01
ag
•
•
•
•
•
Manage device WWN to N_Port group mappings.
•
•
Delete the backup mappings for the given N_Port, if any.
2
Manage device WWN failover to N_Ports configured as preferred failover ports.
Enable or disable device WWN mappings.
Configure the reliability limit for the preferred N_Port.
Save the configured F_Ports, static F_Ports for the given N_Port, and F_Ports for which the given
N_Port is a preferred one.
Display the saved mappings for the given N_Port, if any.
AG configuration changes are saved persistently as configuration keys. Use the portCfgNPort
command to set a port as N_Port.
This command supports multiple configurations for mapping device logins to N_Ports for the purposes of
load balancing and redistribution in the event of a fabric change. If multiple mappings are configured, the
system considers the available mappings in a fixed order of priority to determine which of the available
N_Ports should be assigned to the login request. The first eligible mapping is chosen in the order
specified below.
NOTES
1.
Device WWN to N_Port
2.
Device WWN to N_Port Group
3.
Automatic device WWN load balancing.
4.
F_Port to N_Port
5.
F_Port to N_Port Group
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
AG is supported only on selected Brocade hardware platforms. Refer to the Access Gateway
Administrator's Guide for hardware support and AG configuration procedures.
In non-AG mode, only two actions are available: --modeenable and --modeshow.
The --backupmappingsave, --backupmappingdel and --backupmappingshow commands can be
executed if the auto policy is disabled.
OPERANDS
This command has the following operands:
--help
Displays the command usage.
--show
Displays the current configuration of the Access Gateway. This includes all
N_Ports and F_Ports that are currently online, failover and failback settings as
well as any online F_Ports that are currently mapped to N_Ports. Failover and
failback policies are displayed as enabled (1) or disabled (0).
--modeshow
Displays the current Access Gateway operating mode of the switch as either
enabled or disabled.
--modeenable
Enables Access Gateway mode on a switch. Long distance mode settings should
be cleared for all ports on the NPIV edge switch to which the AG is connected.
Otherwise, the NPIV switch port displays the long distance port type along with
the F_Port.
Fabric OS Command Reference
53-1003108-01
25
2
ag
--modedisable
Disables Access Gateway mode on a switch. After AG mode is disabled, the
switch reboots automatically and comes online with default zone access set to
"No Access". In order to merge the switch to a fabric, set the default zone to "All
Access" and disable/enable the E_Port.
--policyshow
Displays the supported AG port policies and their status as either enabled or
disabled. AG supports four types of policies:
•
•
•
•
Port Grouping (pg) policy: This policy manages failover of an F_Port to a set
of related N_Ports in a port group.
Auto Port Configuration (auto): When this policy is enabled, the AG enabled
switch automatically detects available ports and maps F_Ports to N_Ports.
Auto port configuration is disabled by default.
Advanced Device Security (ADS) policy. This policy restricts access to the
fabric at the AG level to a set of authorized devices. Unauthorized access is
rejected and the system logs a RASLOG message. You can configure the list
of allowed devices for each F_Port by specifying their Port WWN. Refer to the
ag --ads* commands for information on managing advanced device security.
ADS policy is disabled by default, which means that all devices can connect
to the switch.
WWN Based Load Balancing policy: This policy routes device logins to the
least loaded port in the port group to which they are mapped.
--policyenable policy
Enables the specified port policy for the Access Gateway. When a new policy is
enabled, all port related configuration settings are lost. Use the configUpload
command to save the current port configuration. Valid policies include the
following:
pg
Enables the port grouping policy. A default port group "pg0" is created, which
includes all configured N_Ports assigned to the policy. Enabling port grouping
policy disables the Get Fabric Name policy.
auto
Enables the automatic port configuration policy. When enabled, this policy applies
to all ports on the switch. All F_Port to N_Port mapping and port group
configurations are ignored.
ads
Enables the advanced device security (ADS) policy. When enabled, this policy
applies to all the ports on the switch. By default all devices have access to the
fabric on all ports.
wwnloadbalance
Enables the device WWN load balancing policy. When this policy is enabled,
device logins are sent to the least loaded port in the port group to which they are
mapped. These devices are displayed with ag --wwnmapshow as dynamic
device mappings. Port Group policy must be enabled before you can enable the
WWN load balancing policy.
--policydisable policy
Disables the specified policy for the Access Gateway. When a policy is disabled,
all port-related configuration settings are lost. Use the configUpload command to
save the current port configuration. Valid policies include the following:
pg
Disables the port grouping policy. All port group configurations are deleted.
Disabling port grouping policy enables the Get Fabric Name policy.
26
Fabric OS Command Reference
53-1003108-01
ag
2
auto
Disables the automatic port configuration policy and deletes all associated
configuration settings.
ads
Disables the advanced device security (ADS) policy and deletes all lists of allowed
device WWNs.
wwnloadbalance
Disables the device WWN load balancing policy.
--mapshow [N_Port | device_WWN]
Displays the F_Ports that are configured and currently mapped to a given
"primary" N_Port. Optionally specify an N_Port to display the F_Ports that are
mapped to the specified N_Port only, or specify a device WWN to display the
N_Port to which the device WWN is mapped. Failover and failback policies are
displayed as enabled (1) or disabled (0).
--mapset N_Port [F_Port1;F_Port2;...]
Maps a set of F_Ports to a specified "primary" N_Port forcing all traffic from the
F_Ports to be routed through this N_Port to the attached fabric. An F_Port cannot
be mapped to more than one primary N_Port at any given time. F_Ports are
enabled only if the N_Port is online. This command overwrites existing port
mappings. Use a blank list ("") to clear current mappings.
--mapadd N_Port F_Port1 [; F_Port2;...]
Adds one or more specified F_Ports to the mapping of an existing "primary"
N_Port. The traffic for the configured F_Ports is routed to the fabric through the
specified N_Port when the F_Ports come online. An F_Port cannot be mapped to
more than one primary N_Port at the same time.
--mapdel N_Port F_Port1 [; F_Port2;...]
Deletes one or more specified F_Ports from the "primary" N_Port mapping.
--staticadd N_Port F_Port1 [; F_Port2;...]
Creates a static mapping between an existing "primary" N_Port and one or more
specified F_Ports. This command removes exiting mappings. Once the static
mapping is enabled, the F_Ports and all logged-in devices will logout of the
previous N_Port and login using the new N_Port.
--staticdel N_Port F_Port1 [; F_Port2;...]
Deletes a static mapping between an existing "primary" N_Port and one or more
specified F_Ports. This command removes exiting mappings. Alternately, you can
remove an existing mapping by mapping the F_Port to another N_Port.
--pgshow [pgid]
Displays the Port Group configuration. The port grouping feature supports
specifying a set of N_Ports to be included in the Port Group (PG) Policy. The
factory default PG is "pg0", which includes all N_Ports. The default PG cannot be
removed or renamed.
--pgcreate pgid
"N_Port1 [;N_Port2;...]" [-n pgname][-m "lb; mfnm"]
Creates a port group with the ID pgid and a specified list of N_Ports to be included
in the policy. The list must be enclosed in quotation marks. Ports must be
separated by semicolons. The Port Group ID must not exceed 64 characters.
Optionally specify a name for the port group and a mode. Modes are by default
disabled. For an explanation of mode values, refer to --pgsetmodes.
--pgadd pgid "N_Port1 [; N_Port2;...]"
Adds one or more N_Ports to the specified port group. The port list must be
enclosed in quotation marks. Ports must be separated by semicolons.
Fabric OS Command Reference
53-1003108-01
27
2
ag
--pgdel pgid "N_Port1 [; N_Port2;...]"
Deletes one or more N_Ports from the specified port group. Deleted ports are
added to the default port group "pg0". The port list must be enclosed in quotation
marks. Ports must be separated by semicolons.
--pgrename pgid newname
Replaces the name of an existing port group with the specified new name. The
port group ID must not exceed 64 characters.
--pgremove pgid
Deletes the specified port group. The N_Ports in the port group that was deleted
are moved to the default port group, which is pgid 0.
--pgmapadd pgid "F_Port1[;F_Port2;...]"
Maps the specified F_Ports to the PG identified by the pgid. Upon execution, the
system identifies the least loaded N_Port in the port group and maps the F_Ports
to that N_Port. The port list must be enclosed in double quotation marks. Ports
must be separated by semicolons. Login balancing (LB) mode must be enabled
on the port group for this command to succeed. Use ag --pgsetmodes to enable
LB mode.
--pgmapdel pgid "F_Port1[;F_Port2;...]"
Removes one or more F_Ports that are part of the port group identified by the pgid
from their mapping to a corresponding N_Port. The port list must be enclosed in
double quotation marks. Ports must be separated by semicolons. Login balancing
(LB) mode must be enabled on the port group for this command to succeed. Use
ag --pgsetmodes to enable LB mode.
--pgsetmodes pgid "lb;mfnm"
Sets the APC modes for the specified port group. The mode list must be enclosed
in double quotation marks and the modes must be separated by a semicolon.
Alternately you can set the modes at the time when you create the port group with
the pgcreate command. The following modes are supported:
lb
Specifies the login balancing mode for the specified port group. If login balancing
mode is enabled and an F_Port goes offline, logins in the port group are
redistributed among the remaining F_Ports. Similarly, if an N_Port comes online,
port logins in the PG are redistributed to maintain a balanced N_Port to F_Port
ratio. This operation is disruptive. Login balancing mode is disabled by default in
all port groups.
mfnm
Enables the managed fabric name monitoring mode (MFNM) in the specified port
group. This command changes the fabric name monitoring mode from "default" to
"managed". In both default and managed mode, the system queries the fabric
name once every 120 seconds, and if it detects an inconsistency, for example, if
the port group is connected to multiple fabrics, it triggers a RASLOG message.
The difference between default and managed fabric name monitoring is that in
managed mode, failover is disabled for all ports in the port group if the system
detects an inconsistency in fabric names.
You can add or remove MFNM from a port group, however, doing so will enable or
disable MFNM on the entire switch. RASLOG messages are generated only if
MFNM is enabled on the entire switch and multiple fabrics are connected to the
switch.
--pgdelmodes pgid "lb;mfnm"
Disables the specified modes on a given port group. The mode list must be
enclosed in double quotation marks and the modes must be separated by a
semicolon. For a description of supported modes, refer to --pgsetmodes.
28
Fabric OS Command Reference
53-1003108-01
ag
2
--pgfnmtov new_tov
Displays the fabric name monitoring timeout value in seconds when used without
specifying a new value. To change the current value, specify a new timeout value
in seconds. The valid range is 30 to 120 seconds. The default value is 120
seconds.
--failoverenable [N_Port] | -pg pgid
Enables the failover policy for a given N_Port or for all N_Ports in the given port
group. When failover policy is enabled for a given N_Port, F_Ports behave as
follows:
•
•
If only primary F_Port to N_Port mapping is in place, all currently mapped
F_Ports fail over to another available N_Port in the event the original N_Port
becomes disabled. If multiple N_Ports are available for failover, F_Ports are
evenly balanced across all available N_Ports. If no other N_Port is available,
failover does not occur.
If preferred secondary F_Port to N_Port Mapping is in place, the F_Ports are
routed through the preferred Secondary N_Port. If the preferred secondary
N_Port is offline, the F_Ports are disabled.
--failoverdisable [N_Port] -pg pgid
Disables the failover policy for a given N_Port or for all N_Ports in the given port
group.
--failovershow [N_Port]
If an N_Port is specified (optional), the command displays the failover policy for
this N_Port. Otherwise, the failover policy for all N_Ports is displayed. Failover is
displayed as enabled (1) or disabled (0).
--failbackenable [N_Port] | -pg pgid
Enables the failback policy for a specified N_Port or for all N_Ports in the given
port group. When failback policy is enabled, ports behave as follows:
•
•
If only primary F_Port to N_Port mapping is in place, all F_Ports are
automatically rerouted back to the N_Ports to which they were originally
mapped as those N_Ports come back online. Only the originally mapped
F_Ports fail back. In the case of multiple N_Port failures, only F_Ports that
were mapped to the recovered N_Port experience failback. The remaining
F_Ports are not redistributed among the online N_Ports during the failback.
If preferred secondary F_Port to N_Port mapping is in place, and the primary
N_Port comes back online, then the F_Ports are rerouted through the primary
N_Port. If the secondary N_Port comes online, while the primary N_Port is
still offline, F_Ports are rerouted through the secondary N_Port.
--failbackdisable [N_Port] | -pg pgid
Disables the failback policy for the specified N_Port or for all N_Ports in the given
port group.
--failbackshow [N_Port]
If an N_Port is specified (optional), the command displays the failback policy for
this N_Port. Otherwise, the failover policy for all the N_Ports is displayed. The
failback policy is displayed as disabled (0) or enabled (1).
--prefset "F_Port [;F_Port2;...]" N_Port
Sets the preferred secondary N_Port for one or more F_Ports. Preferred mapping
is optional. Preferred F_Port to N_Port Mapping provides an alternate N_Port for
F_Ports to come online for predictable failover and failback. An F_Port must have
primary N_Port mapping before a secondary N_Port can be configured. The list of
F_Ports to be mapped must be enclosed in double quotation marks. Port numbers
must be separated by semicolons.
Fabric OS Command Reference
53-1003108-01
29
2
ag
--prefdel "F_Port [;F_Port2;...]" N_Port
Deletes the preferred Secondary N_Port for the specified F_Ports. The list of
F_Ports to be deleted from the secondary mapping must be enclosed in double
quotation marks. Port numbers must be separated by semicolons.
--prefshow
Displays the preferred Secondary N_Port for all F_Ports.
--adsset "F_Port [;F_Port2;...]" "WWN [;WWN2;...]"
Sets the list of devices that are allowed to login to a specified set of F_Ports.
Devices are specified by their world wide names. Lists must be enclosed in double
quotation marks. List members must be separated by semicolons. The maximum
number of entries in the allowed device list is twice the per port maximum login
count. Replace the WWN list with an asterisk (*) to indicate all access on the
specified F_Port list. Replace the F_Port list with an asterisk (*) to add the
specified WWNs to all the F_Ports' allow lists. A blank WWN list ("") indicates no
access. ADS policy must be enabled for this command to succeed.
--adsadd "F_Port [;F_Port2;...]" "WWN [;WWN2;...]"
Adds the specified WWNs to the list of devices allowed to login to the specified
F_Ports. Lists must be enclosed in double quotation marks. List members must be
separated by semicolons. Replace the F_Port list with an asterisk (*) to add the
specified WWNs to all the F_Ports' allow lists. ADS policy must be enabled for this
command to succeed.
--adsdel "F_Port [;F_Port2;...]" "WWN [;WWN2;...]
Deletes the specified WWNs from the list of devices allowed to login to the
specified F_Ports. Lists must be enclosed in double quotation marks. List
members must be separated by semicolons. Replace the F_Port list with an
asterisk (*) to remove the specified WWNs from all the F_Ports' allow lists. ADS
policy must be enabled for this command to succeed.
--adsshow
Displays the list of allowed device WWNs for all F_Ports.
--persistentalpaenable 1 | 0 mode
Configures the persistent ALPA feature. Once enabled, the ALPA parts of all
device PIDs become persistent regardless of whether they were logged in before
or after the persistent ALPA feature was enabled. ALPA persistence ensures that
there is no inconsistency between logged in devices. The persistent ALPA feature
is disabled by default.
1|0
Specify 1 to enable persistent ALPA. Specify 0 to disable the feature.
mode
Specifies the manner in which the ALPA is obtained in the event that the ALPA
value is already taken by another host. Valid modes include the following:
-s
Specifies a stringent ALPA request mode. In stringent mode, the login is
rejected if the ALPA is not available.
-f
Specifies a flexible ALPA request mode. In flexible mode, the host login is
accepted either with the requested ALPA value or with a different ALPA value
if the requested ALPA is not available.
--printalpamap F_Port
Displays the database entry for the specified port. An F_Port must be specified.
The output displays the PWWN-to-host-ALPA mapping.
30
Fabric OS Command Reference
53-1003108-01
ag
2
--deletepwwnfromdb PWWN
Removes the specified port WWN entry from the database after the host has
logged out.
--clearalpamap F_Port
Clears the ALPA values for the specific F_Port. This command removes the
PWWN-to-ALPA-value mapping from the database.
--addwwnmapping N_Port "WWN [;WWN2;...]" | --all
Maps one or more device WWNs to a preferred N_Port. All traffic form the
specified devices is forced through the specified N_Port, regardless of which
F_Port the device logs into. In the event the designated N_Port should become
unavailable, an alternate port can serve as a preferred failover port. This
command only affects devices that are connecting to the fabric after successful
execution of this command; it will not affect devices already logged in. If a device
is already connected to the switch when its mapping is created, that mapping
goes into effect the next time the device connects. The WWN list must be
enclosed in double quotation marks. WWNs must be separated by semicolons.
The --all option indicates all device WWNs already mapped, for example, if you
wish to change an existing WWN mapping. It does not affect device WWNs that
are not part of an existing mapping.
--delwwnmapping N_Port "WWN [;WWN2;...]" | --all
Removes the mapping of one or more device WWNs to a preferred N_Port. The
--all option removes the mapping for all device WWNs currently mapped to the
specified N_Port. The WWN list must be enclosed in double quotation marks.
WWNs must be separated by semicolons. The mappings are removed upon
execution of this command.
--addwwnpgmapping PG "WWN [;WWN2;...]" | --all
Maps one or more device WWNs to any of the N_Ports included in the specified
port group . The port group is identified by its port group ID. The --all option maps
all currently mapped device WWNs to the specified port group. The WWN list
must be enclosed in double quotation marks. WWNs must be separated by
semicolons. The device WWN to port group mapping takes effect the next time
the device logs in.
--delwwnpgmapping PG "WWN [;WWN2;...]" | --all
Removes the mapping between the specified device WWNs and the specified port
group. The port group is identified by its port group ID. The --all option removes
the mapping of all device WWNs currently mapped to the specified port group.
The WWN list must be enclosed in double quotation marks. WWNs must be
separated by semicolons. The mappings are removed upon execution of this
command.
--addwwnfailovermapping N_Port "WWN [;WWN2;...]"| --all
Maps one or more device WWNs to a preferred failover N_Port. If the N_Port to
which the WWNS are mapped is not available or goes down, the device logins fail
over to the preferred failover N_Port. The --all option maps all currently mapped
device WWNs to the specified failover N_Port. The WWN list must be enclosed in
double quotation marks. WWNs must be separated by semicolons.
--delwwnfailovermapping N_Port "WWN [;WWN2;...]" | --all
Deletes the mapping of one or more device WWNs to a preferred failover N_Port.
The --all option deletes the failover mappings of all device WWNs currently
mapped to the specified N_Port. The WWN list must be enclosed in double
quotation marks. WWNs must be separated by semicolons.
Fabric OS Command Reference
53-1003108-01
31
2
ag
--wwnmappingdisable "WWN [;WWN2;...]" | --all
Disables one or more device WWN mappings. Use this command if you want to
disable the mapping action temporarily without making permanent changes to the
mappings. The mappings remain disabled until they are re-enabled or deleted.
The --all option disables all currently existing device WWN mappings.
--wwnmappingenable "WWN [;WWN2;...]" | --all
e-enables one or more previously disabled device WWN mappings. The --all
option re-enables all previously disabled device WWN mappings.
--wwnmapshow
Displays all device WWN mappings. For each device WWN, the command
displays the N_Port number to which it is mapped, the secondary (failover)
N_Port, and the port group if applicable. The "Current" field shows the port the
device is currently using. If the device is not logged in, the field displays "none." If
the device is logged in to a port other than the one it is mapped to, the field
displays that port. If the device is mapped to a port group, the field displays the
number of the port within that port group that the device is currently using. If the
device is using a trunk, the field displays which port in that trunk the device is
logged in. The "Enabled" field indicates, whether a mapping has been temporarily
disabled ("no"), or whether it is in enabled state ("yes").
--reliabilitycounterset count
Sets the reliability limit for the preferred N_Port. This parameter controls the
number of ONLINE or OFFLINE State Change Notification (SCN) messages a
port can receive before becoming unreliable. The range is 10 through 100. The
default value is 25.
The port becomes reliable again if it does not receive any SCN messages for a
period of five minutes. Preferred N_Port settings are not enforced on unreliable
N_Ports. When the port becomes reliable again, the behavior is as follows:
•
•
•
If a FAILBACK flag is set, the port will fail back the configured F_Ports.
Configured F_Ports that are offline will come back online.
If LB mode or auto policy is configured, load rebalancing resumes.
--reliabilitycountershow
Displays the configured reliability limit for N_Ports.
--backupmappingsave N_Port
Saves the configured F_Ports, static F_Ports for the given N_Port, and F_Ports
for which the given N_Port is a preferred one.
--backupmappingdel N_Port
Deletes the backup mappings for the given N_Port, if any.
--backupmappingshow N_Port
Displays the saved mappings for the given N_Port, if any.
EXAMPLES
To display the current state of the Access Gateway with Failover (FO) and Failback (FB) enabled on
N_Ports 9 and 12:
switch:admin> ag --show
Name
: core_ag
NodeName
: 10:00:00:05:1e:85:ae:f8
Number of Ports
: 40
IP Address(es)
: 10.17.31.2
Firmware Version : v7.1.0ING
N_Ports
: 8
F_Ports
: 5
Policies enabled : pg
32
Fabric OS Command Reference
53-1003108-01
ag
2
Persistent ALPA
: Disabled
Static WWN Map
: None
Port Group information :
PG_ID PG_Members
PG_Name
PG_Mode
---------------------------------------------0
0;1;2;3;8;
pg0
9;10;11;32;33;
34;35;36;37;38;
39
---------------------------------------------Fabric Information :
Attached Fabric Name
N_Ports
--------------------------------------------10:00:00:05:1e:d6:f8:c9
0;1;2;3;8;
9;10;11
--------------------------------------------N_Port information :
Port PortID
Attached PWWN
Attached_Switch
F-port\
-------------------------------------------------\
0
0x010100 50:00:51:ed:6f:8e:60:28
Spirit\
1
0x010100 50:00:51:ed:6f:8e:60:28
Spirit\
2
0x010100 50:00:51:ed:6f:8e:60:28
Spirit\
3
0x010100 50:00:51:ed:6f:8e:60:28
Spirit\
8
0x010d00 20:0d:00:05:1e:d6:f8:c9
Spirit\
9
0x010c00 20:0c:00:05:1e:d6:f8:c9
Spirit\
10
0x010e00 20:0e:00:05:1e:d6:f8:c9
Spirit\
11
0x010f00 20:0f:00:05:1e:d6:f8:c9
Spirit\
Switch FO FB IP_Addr
F_Ports
----------------------------------------0
1
1
10.17.31.170
4;5;23;
0
1
1
10.17.31.170
None
0
1
1
10.17.31.170
None
0
1
1
10.17.31.170
None
13
1
1
10.17.31.170
6;
12
1
1
10.17.31.170
7;
14
1
1
10.17.31.170
None
15
1
1
10.17.31.170
None
-----------------------------------------F_Port information :
Port PortID
Attached PWWN
N_Port\
----------------------------------------------- \
4
0x010103 20:00:00:05:1e:85:92:88
0 \
5
0x010102 20:01:00:05:1e:85:92:88
0 \
6
0x010d01 20:02:00:05:1e:85:92:88
8 \
7
0x010c01 20:03:00:05:1e:85:92:88
9 \
23
0x010101 10:00:00:05:1e:65:95:81
0 \
Preferred N_port Login Exceeded?
--------------------------------------None
No
None
No
None
No
None
No
None
No
----------------------------------------------Static N-Port to F-Port Mapping :
Fabric OS Command Reference
53-1003108-01
33
2
ag
N-Port
F-Port
---------------------------------------------0
None
1
None
2
None
3
None
8
None
9
None
10
None
11
None
---------------------------------------------
To display the current Access Gateway mode:
switch:admin> ag --modeshow
Access Gateway mode is enabled.
switch:admin> ag --modeshow
Access Gateway mode is NOT enabled.
AG group policy commands
To show current policies:
switch:admin> ag --policyshow
AG Policy
Policy Name
State
----------------------------------------------------Port Grouping
pg
Enabled
Auto Port Configuration
auto
Disabled
Advanced Device Security
ads
Disabled
WWN Based Load Balancing
wwnloadbalance Disabled
-----------------------------------------------------
To enable a port grouping policy:
switch:admin> ag --policyenable pg
To disable a port grouping policy
switch:admin> ag --policydisable pg
To enable auto port configuration policy when both policies are disabled and the switch is already
disabled:
switch:admin> ag --policyenable auto
All Port related Access Gateway configurations will be lost.
Please save the current configuration using configupload.
Do you want to continue? (yes, y, no, n): [no] y
To disable auto port configuration policy when the switch is disabled:
switch:admin> ag --policydisable auto
Default factory settings will be restored.
Default mappings will come into effect.
Please save the current configuration using configupload.
Do you want to continue? (yes, y, no, n): [no] y
Access Gateway configuration has been restored \
to factory default
To enable the ADS policy:
switch:admin> ag --policyenable ads
34
Fabric OS Command Reference
53-1003108-01
ag
2
To disable the ADS policy:
switch:admin> ag --policydisable ads
To enable the WWN load balancing policy:
switch:admin> ag --policyenable wwnloadbalance
To disable the WWN load balancing policy:
switch:admin> ag --policydisable wwnloadbalance
AG port mapping commands
To display current port mappings and port grouping policies:
switch:admin> ag --mapshow
N_Port Configured Static Current Failover Failback PG_ID PG_Name
_F_Ports _F_Ports _F_Ports
----------------------------------------------------------------0
4;5;6
None
4;5;6
1
0
2 SecondFabric
1
7;8;9
None
7;8;9
0
1
0 pg0
2
10;11
None
10;11
1
0
2 SecondFabric
3
12;13
None
12;13
0
1
0 pg0
------------------------------------------------------------------
Explanation of fields in --mapshow output:
•
•
Static F_Ports are part of static F_Port to N_Port mapping.
•
•
•
Configured F_Ports are the F_Ports that are explicitly mapped to this N_Port (saved in config).
Current F_Ports are the F_Ports that are currently online and mapped to a given N_Port either
because they are mapped to that N_Port or as a result of N_Port failover.
Failover and Failback indicate whether or not N_Port policy is enabled (1) or disabled (0).
PG_ID is the Port Group ID and PG_Name is the Port Group Name.
To clear all F_Ports mapped to the configured primary N_Port 0:
switch:admin> ag --mapset 0 ""
F_Port to N_Port mapping has been updated successfully
To add F_Ports 4 and 6 to N_Port 0 (observe that Port 0 has no configured F_Ports):
switch:admin> ag --mapset 0 "4;6"
F_Port to N_Port mapping has been updated successfully
To add F_Port 5 to N_Port 2 (observe that N_Port 2 already has mapped F_Ports):
switch:admin> ag --mapadd 2 "5"
To display the new mappings:
switch:admin> ag --mapshow
N_Port Configured Static Current Failover Failback PG_ID PG_Name
_F_Ports _F_Ports F_Ports
-----------------------------------------------------------------
Fabric OS Command Reference
53-1003108-01
35
2
ag
0
4;6
None
4;6
1
0
2
SecondFabric
1
7;8;9
None
7;8;9
0
1
0
pg0
2
5;10;11
None
5;10;11
1
0
2
SecondFabric
3
12;13
None
12;13
0
1
0
pg0
------------------------------------------------------------------
To delete F_Port 5 that was mapped to N_Port 2:
switch:admin> ag --mapdel 2 "5"
Preferred N_port is set for F_Port[s]
Please delete it before removing primary N_Port
ERROR:Unable to remove F_Port[s] from mapping,
retry the command
switch:admin> ag --prefshow
F_Ports
Preferred N_Port
----------------------------------------------10;11
0
4;5;6
2
7;8;9
3
---------------------------------------------switch:admin> ag --prefdel 5 2
Preferred N_Port is deleted successfully \
for the F_Port[s]
switch:admin> ag --mapdel 2 "5"
F_Port to N_Port mapping has been updated successfully
To create and display a static mapping:
switch:admin> ag --staticadd 17 1
switch:admin> ag --show
N_Port information :
Port PortID
Attached PWWN
Attached_Switch
F-port\
-----------------------------------------------------\
0
0x010100 50:00:51:ed:6f:8e:60:28
Spirit
\
17 0x010100 50:00:51:ed:6f:8e:60:28
Spirit
\
Switch FO FB IP_Addr
F_Ports
-------------------------------------------0
1
1
10.17.31.170
4;5;23;
0
1
1
10.17.31.170
None
------------------------------------------F_Port information :
Port PortID
Attached PWWN
N_Port Preferred \
-----------------------------------------------4 0x010103 20:00:00:05:1e:85:92:88 0
\
5 0x010102 20:01:00:05:1e:85:92:88 0
\
N_port Login Exceeded?
------------------------None
No
None
No
--------------------------------------------------N_Port Configured Current Failover Failback PG_ID PG_Name
36
Fabric OS Command Reference
53-1003108-01
ag
2
_F_Ports _F_Ports
--------------------------------------------------0
None
None
1
1
N/A
N/A
17
2
2
0
0
N/A
N/A
--------------------------------------------------Static N-Port to F-Port Mapping
N-Port
F-Port
-----------------------------------------17
1
------------------------------------------
AG failover policy commands
To display failover policy settings for all N_Ports:
switch:admin> ag --failovershow
N_Port failover_bit
--------------------------0
1
1
0
2
1
3
0
To set and display failover and failback policies on a single port:
switch:admin> ag --failoverenable 1
Failover policy is enabled for port 1
switch:admin> ag --failoverdisable 0
Failover policy is disabled for port 0
switch:admin> ag --failovershow 0
Failover on N_Port 0 is not supported
switch:admin> ag --failbackdisable 2
Failback policy is disabled for port 2
switch:admin> ag --failbackshow 2
Failback on N_Port 2 is not supported
switch:admin> ag --failbackenable 2
Failback policy is enabled for port 2
To display failback policy settings for all the N_Ports:
switch:admin> ag --failbackshow
N_Port failback_bit
--------------------------0
0
1
1
2
0
3
1
Fabric OS Command Reference
53-1003108-01
37
2
ag
To set and display failback policy settings on a single port:
switch:admin> ag --failbackenable 0
Failback policy cannot be enabled since failover
policy is disabled for port 0
switch:admin> ag --failbackenable 2
Failback policy is enabled for port 2
switch:admin> ag --failbackenable 3
Failback on N_Port 3 is not supported
switch:admin> ag --failbackenable 2
Failback on N_Port 2 is supported
Port Group commands
To display Port Group information:
switch:admin> ag --pgshow
PG_ID PG_Name
PG_Mode N_Ports
F_Ports
----------------------------------------------0
pg0
lb,mfnm
1;3
10;11
2
SecondFabric 0;2
4;5;6
-----------------------------------------------
To create a port group "FirstFabric" that includes N_Ports 1 and 3 and has login balancing enabled:
switch:admin> ag --pgcreate 3 "1;3" -n FirstFabric1 -m "lb"
Port Group 3 created successfully
switch:admin> ag --pgshow
PG_ID PG_Name
PG_Mode
N_Ports
F_Ports
----------------------------------------------0
pg0
lb,mfnm
none
none
2
SecondFabric
0;2
4;5;6
3
FirstFabric
lb
1;3
10;11
-----------------------------------------------
To rename the port group with pgid 2 to "MyEvenFabric":
switch:admin> ag --pgrename 2 MyEvenFabric
Port Group 2 has been renamed as MyEvenFabric successfully
switch:admin> ag --pgshow
PG_ID PG_Name
PG_Mode
N_Ports
F_Ports
----------------------------------------------0
pg0
lb,mfnm
none
none
2
MyEvenFabric
0;2
4;5;6
3
FirstFabric
lb
1;3
10;11
-----------------------------------------------
38
Fabric OS Command Reference
53-1003108-01
ag
2
To remove the port group with pgid 2:
switch:admin> ag --pgremove 2
Port Group 2 has been removed successfully
switch:admin> ag --pgshow
PG_ID PG_Name
PG_Mode N_Ports
F_Ports
----------------------------------------------0
pg0
lb,mfnm
0;2
4;5;6
3
FirstFabric lb
1;3
10;11
-----------------------------------------------
To enable managed fabric name monitoring in port group 3:
switch:admin> ag --pgsetmodes 3 "mfnm"
Managed Fabric Name Monitoring mode has been \
enabled for Port Group 3
switch:admin> ag --pgshow
PG_ID PG_Name
PG_Mode N_Ports
F_Ports
----------------------------------------------0
pg0
lb,mfnm
0;2
4;5;6
3
FirstFabric lb,mfnm
1;3
10;11
-----------------------------------------------
To disable managed fabric name monitoring in port group 3:
switch:admin> ag --pgdelmodes 3 "mfnm"
Managed Fabric Name Monitoring mode has been disabled for Port Group 3
switch:admin> ag --pgshow
----------------------------------------------0
pg0
lb,mfnm
0;2
4;5;6
3
FirstFabric
lb
1;3
10;11
-----------------------------------------------
To get the current fabric name monitoring timeout value:
switch:admin> ag --pgfnmtov
Fabric Name Monitoring TOV: 120 seconds
To set the fabric name monitoring timeout value to 30 seconds:
switch:admin> ag --pgfnmtov 30
AG Preferred port information commands
To display preferred port settings for F_Ports:
switch:admin> ag --prefshow
F_Ports
Preferred N_Port
-----------------------------------------10;11
0
12;13
1
4;6
2
7;8;9
3
------------------------------------------
Fabric OS Command Reference
53-1003108-01
39
2
ag
To delete secondary port mapping for F_Ports 7, 8 and 9:
switch:admin> ag --prefdel "7;8;9" 3
Preferred N_Port is deleted successfully \
for the F_Port[s]
To set secondary port mapping for F_Ports 7, 8 and 9:
switch:admin> ag --prefset "7;8;9" 3
Preferred N_Port is set successfully \
for the F_Port[s
ADS Policy commands
To set the list of allowed devices for Ports 11 and 12 to 'no access':
switch:admin> ag --adsset "11;12" ""
WWN list set successfully as the Allow Lists of \
the F_Port[s]
To set the list of allowed devices for Ports 1, 10 and 13 to 'all access':
switch:admin> ag --adsset "1;10;13" "*"
WWN list set successfully as the Allow Lists of \
the F_Port[s]
To remove two devices from the lists of allowed devices for ports 1 and 9:
switch:admin> ag --adsdel "3;9" \
"22:03:08:00:88:35:a0:12;22:00:00:e0:8b:88:01:8b"
WWNs removed successfully from Allow Lists of the\
F_Port[s]
To add a two new device to the lists of allowed devices for ports 1 and 9:
switch:admin> ag --adsadd "3;9" \
"20:03:08:00:88:35:a0:12;21:00:00:e0:8b:88:01:8b"
WWNs added successfully to Allow Lists of the \
F_Port[s]
To display the lists of allowed devices on the switch:
switch:admin> ag --adsshow
F_Port
WWNs Allowed
------------------------------------------1
ALL ACCESS
3
20:03:08:00:88:35:a0:12
21:00:00:e0:8b:88:01:8b
9
20:03:08:00:88:35:a0:12
21:00:00:e0:8b:88:01:8b
10
ALL ACCESS
11
NO ACCESS
12
NO ACCESS
13
ALL ACCESS
--------------------------------------------
Persistent ALPA configuration commands
To enable persistent ALPA in flexible mode:
switch:admin> ag --persistentalpaenable 1 -f
Persistent ALPA mode is enabled
40
Fabric OS Command Reference
53-1003108-01
ag
2
To enable persistent ALPA in stringent mode:
switch:admin> ag --persistentalpaenable 1 -s
Persistent ALPA mode is enabled
To disable persistent ALPA mode:
switch:admin> ag --persistentalpaenable 0
Persistent ALPA mode is enabled
To display the ALPA database entries for F_Port 5:
switch:admin> ag --printalpamap 5
Hash table for Port 5 data
PWWN
ALPA
============================================
20:12:00:05:1e:85:92:88
1
20:07:00:05:1e:01:0b:4a
3
To attempt to remove a device entry from the database while the device is online and cannot be
removed:
switch:admin> ag --deletepwwnfromdb \
0:12:00:05:1e:85:92:88 20:08:00:05:1e:01:0b:4a Online. \
Cannot delete an online device
To remove a device entry from the database when the device is offline:
switch:admin> ag --deletepwwnfromdb \
0:12:00:05:1e:85:92:88
Device 20:13:00:05:1e:85:92:88 successfully deleted
To remove a device entry from the database when the device is not present in the table
switch:admin> ag --deletepwwnfromdb \
0:12:00:05:1e:85:92:00 20:12:00:05:1e:85:92:00 not found.
Please check the device name
To remove the PWWN to ALPA value for port 5 from the database and to verify the removal:
switch:admin> ag --clearalpamap 5
ALPA Table for port 5 is cleared
switch:admin> ag --clearalpamap 5
Hash table for Port 5 data
PWWN
ALPA
============================================
Hash Table is empty
Device WWN mapping commands
To create a WWN to N_Port mapping for two devices.
switch:admin> ag --addwwnmapping 8 \
"0:12:00:05:1e:85:92:88; 0:12:00:05:1e:85:92:88"
To delete one of the device WWN to N_Port mappings.
switch:admin> ag --delwwnmapping 8
"0:12:00:05:1e:85:92:88"
Fabric OS Command Reference
53-1003108-01
\
41
2
ag
To create a WWN to port group mapping for all currently mapped devices (this command does not affect
devices not already mapped or connecting later).
switch:admin> ag --addwwnpgmapping 4 --all
To add port 13 as a preferred failover N_Port for a device:
switch:admin> ag --addwwnfailovermapping 13 "0:12:00:05:1e:85:92:88"
To disable all WWN mappings:
switch:admin> ag --wwnmappingdisable --all
To display the WWN mappings when WWN load balancing policy is not enabled:
switch:admin> ag --wwnmapshow
Static Device Mapping Information:
WWN,
1st N_Port 2nd N_Port PG_ID Current Enabled
---------------------------------------------------------25:f7:00:0c:29:00:02:8b 9
None
None None
yes
25:f7:00:0c:29:00:03:8b 9
None
None None
yes
25:f7:00:0c:29:00:04:8b 9
None
None None
yes
25:f7:00:0c:29:00:05:8b 9
None
None None
yes
25:f7:00:0c:29:00:07:8b 9
None
None None
yes
25:f7:00:0c:29:00:08:8b 9
None
None None
yes
25:f7:00:0c:29:00:09:8b 9
None
None None
yes
25:f7:00:0c:29:00:0a:8b 9
None
None None
yes
---------------------------------------------------------Dynamic Device Mapping Information:
---------------------------------------------------------No dynamic mappings in use
----------------------------------------------------------
To display the WWN mappings when WWN load balancing policy is enabled:
switch:admin> ag --wwnmapshow
Static Device Mapping Information:
WWN,
1st N_Port 2nd N_Port PG_ID Current Enabled
---------------------------------------------------------No static mappings are defined
---------------------------------------------------------Dynamic Device Mapping Information:
WWN,
1st N_Port 2nd N_Port PG_ID Current Enabled
----------------------------------------------------------10:00:00:06:2b:11:52:df 23
None
0
23
yes
-----------------------------------------------------------
To configure and display the reliability counter for the preferred N_Port:
switch:admin> ag --reliabilitycounterset 50
switch:admin> ag --reliabilitycountershow
================================
Reliability Counter = 50
================================
42
Fabric OS Command Reference
53-1003108-01
ag
2
Backup mapping commands
To save the configured, static, and preferred mapping of an N_Port:
switch:admin> ag --backupmappingsave 43
Configured,static and preferred mappings have been saved \
for the N_port successfully.
To display the saved mappings for the given N_Port:
switch:admin> ag --backupmappingshow 43
N_Port
Backed-up Configured F_Ports
: 15;16;17
Backed-up Static F_ports
: 18;19
Backed-up Preferred F_ports
: 27;28
: 43
To delete the backup mappings for the given N_Port:
switch:admin> ag --backupmappingdel 43
Backed up mappings have been deleted for the N_port.
SEE ALSO
agAutoMapBalance, portCfgNPort, portCfgNPIVPort
Fabric OS Command Reference
53-1003108-01
43
2
agAutoMapBalance
agAutoMapBalance
Controls automatic remapping of F_Ports in AG mode.
SYNOPSIS
agautomapbalance --enable [-fport | -nport]
[-pg Port_Group_Number | -all]
agautomapbalance --disable [-fport | -nport]
[-pg Port_Group_Number | -all]
agautomapbalance --force
agautomapbalance --show
agautomapbalance --help
DESCRIPTION
Use this command to control the automatic rebalancing of F_Ports for login distribution in the event that
an F_Port goes offline or an N_Port comes online.
If automatic rebalancing is enabled, and an F_Port goes offline, the remaining F_Port logins are
redistributed across the existing N_Ports. Similarly if a new N_Port comes online, some of the F_Port
logins being routed through existing N_Ports would be failed over to the new N_Ports. Both operations
are potentially disruptive. Disabling automatic rebalancing of login distribution provides a way of avoiding
disruptions associated with routine F_Port/N_Port offline/online events.
The default values for agautomapbalance are as follows:
•
•
Disable automatic login redistribution when F_Ports go offline.
Enable automatic login redistribution when N_Ports come online.
Use the --show option to display the current configuration of the automatic rebalancing feature. The
command output varies depending on current AG policy settings:
•
If Port Group Policy is enabled on the switch, the command displays the following information for
each configured port group:
•
NOTES
OPERANDS
PG_ID - Port Group number
LB mode - Login Balancing mode: enabled or disabled
nport - Enabled or disabled
fport- Enabled or disabled
If Auto Policy is enabled on the switch, the command displays the status of the automatic
rebalancing feature per port type as either disabled or enabled.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--enable
Enables automatic login redistribution upon removal or addition of a specified port
type.
-fport
Enables automatic login redistribution in the event that one or more F_Ports go
offline. When automatic login redistribution is enabled, the remaining F_Ports are
remapped such that logins are balanced among the existing Imports.
44
Fabric OS Command Reference
53-1003108-01
agAutoMapBalance
2
-nport
Enables automatic login redistribution in the event that one or more N_Ports come
online. When automatic login redistribution is enabled, the F_Ports mapped to the
current N_Ports are rebalanced among the N_Ports.
--disable
Disables automatic login redistribution upon removal or addition of a specified port
type.
-fport
Disables automatic login redistribution in the event that one or more F_Ports go
offline. When automatic login redistribution is disabled, the remaining F_Ports
maintain their existing N_Port mappings.
-nport
Disables automatic login redistribution in the event that one or more N_Ports
come online. When auto map balancing is enabled, the F_Ports mapped to the
current N_Ports are rebalanced among the N_Ports.
-pg Port_Group_Number | -all
Specifies the port group number or all port groups. These operands are
mutually exclusive and optional with the --enable and --disable options.
When a port group is specified, command execution is targeted to the
members of that specific port group. When all port groups are specified,
command execution is targeted to all port groups defined in the Access
Gateway. The port group options are allowed only when login balancing is
enabled on the specified port groups.
--force
Enforces automatic login redistribution on a one-time basis in the event that
automatic login redistribution is disabled for N_Port addition, F_Port removal or
both. This command forces rebalancing of the F_Port to N_Port mapping once. It
does not affect the configuration settings.
--show
Displays the auto login distribution configuration.
--help
Displays the command usage.
EXAMPLES
To display the automatic login redistribution settings for port groups 0 and 1:
switch:admin> agautomapbalance --show
AG Policy:
pg
-------------------------------------------PG_ID
LB mode
nport
fport
-------------------------------------------0
Enabled
Enabled
Disabled
1
Disabled
---------------------------------------------
To display the automatic login redistribution settings for N_Ports and F_Ports.
switch:admin> agautomapbalance --show
------------------------------------------------AG Policy:
Auto
------------------------------------------------automapbalance on N_Port Online Event:
Disabled
automapbalance on F_Port Offline Event: Enabled
--------------------------------------------------
Fabric OS Command Reference
53-1003108-01
45
2
agAutoMapBalance
To disable automatic login redistribution on F_Port offline events:
switch:admin> agautomapbalance --disable -fport
To enable automatic login redistribution on F_Ports and N_Ports on port group 1 in the Access Gateway:
switch:admin> agautomapbalance --enable -fport pg 1
To disable automatic login redistribution on F_Ports and N_Ports on all port groups in the Access
Gateway:
switch:admin> agautomapbalance --disable -all
SEE ALSO
46
ag, agShow
Fabric OS Command Reference
53-1003108-01
agShow
2
agShow
Displays the Access Gateway information registered with the fabric.
SYNOPSIS
agshow
agshow --name ag_name
agshow --local
DESCRIPTION
This command displays the details of the F_Ports and the configured N_Ports in the Access Gateway
attached to the fabric. The command output displays the following information.
Name
The name of the Access Gateway.
NodeName
The World Wide Name of the Access Gateway node.
Ports
The number of ports in the Access Gateway.
Enet IP Addr
The IP address of the Access Gateway.
Firmware
Current firmware running on the Access Gateway.
Local/Remote
Indicates whether the Access Gateway is locally or remotely registered to this
switch.
World Wide Name
The world wide name (WWN) of the given Access Gateway.
N-Port ID(s)
The port ids of the N_Ports configured in the given Access Gateway.
N-Ports
The number of configured N_Ports that are online.
F-Ports
The number of F_Ports that are online.
Attached F-Port information
Displays the Port ID, the switch F-port number, and the Port WWN of each F_Port
that is online on the Access Gateway.
Access Gateway F-Port information
Displays the port number, the port ID, and the Port WWN of the Access Gateway
to which the F_Port is connected. This information is displayed only if both the
Access Gateway and the switch to which the Access Gateway is attached are
running Fabric OS v.7.0.0. The data in this section is not always synchronized with
the data in the Attached F-Port information section.
NOTES
NPIV capability should be enabled on the ports connected to the Access Gateway. NPIV capability is
enabled by default. Use portCfgNPIVPort to enable NPIV capability a port if it was previously disabled.
Note that enabling or disabling NPIV capability is no longer supported in Access Gateway mode.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Fabric OS Command Reference
53-1003108-01
47
2
agShow
OPERANDS
This command has the following optional operands:
--name ag_name
Displays information regarding a specific Access Gateway that is registered with
this fabric.
--local
Display information regarding all Access Gateways that are locally registered to
this switch.
EXAMPLES
To display the Access Gateway information registered with the fabric:
switch:admin> agshow --name core_ag
Name
: core_ag
NodeName
: 10:00:00:05:1e:85:ae:f8
N-Port ID(s)
: 0x010100,0x010d00,0x010c00,0x010e00,0x010f00
Number of Ports
: 40
IP Address(es)
: 10.17.31.2
Firmware Version : v7.1.0ING
N-Ports
: 5
F-Ports
: 5
Attached F-Port information :
PortID
Port WWN
Switch F-port
-------------------------------------------------0x010101
10:00:00:05:1e:65:95:81
0
0x010102
20:01:00:05:1e:85:92:88
0
0x010d01
20:02:00:05:1e:85:92:88
13
0x010c01
20:03:00:05:1e:85:92:88
12
Access Gateway F-Port Information :
F-Port NumberF-Port IDF-Port WWN
------------------------------------------------23
0x01010120:17:00:05:1e:85:ae:f8
To display the locally registered Access Gateways:
switch:admin> agshow --local
Worldwide Name
Ports Enet IP Addr Firmware \
----------------------------------------------------\
10:00:00:05:1e:04:06:ae 24 10.32.173.64 v6.4.0
\
Local/Remote Name
---------------------------local
L5D_B14_4024_1
To display all Access Gateways attached to the fabric:
switch:admin> agshow
Worldwide Name
Ports Enet IP Addr Firmware \
----------------------------------------------------\
10:00:00:05:1e:02:b7:2c 16 10.32.173.62 v6.4.0
\
10:00:00:05:1e:04:06:ae 24 10.32.173.64 v6.4.0
\
10:00:00:05:1e:04:06:ae 24 10.32.173.51 v6.4.0
\
Local/Remote Name
---------------------------------local
L5D_B10_4016_1
local
L5D_B14_4024_1
local
L5D_B13_200_AG
SEE ALSO
48
portCfgNPIVPort
Fabric OS Command Reference
53-1003108-01
aliAdd
2
aliAdd
Adds a member to a zone alias.
SYNOPSIS
DESCRIPTION
aliadd "aliName","member[; member...]"
Use this command to add one or more members to an existing zone alias. The alias member list cannot
contain another zone alias.
This command changes the defined configuration. For the change to become effective, enable the zone
configuration with the cfgEnable command. For the change to be preserved across switch reboots, save
the zone configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operands are required:
"aliName"
Specify the name of a zone alias, enclosed in double quotation marks.
"member"
Specify a member or list of members to be added to the alias, enclosed in double
quotation marks. Members must be separated by semicolons. An alias member
can be specified by one or more of the following methods:
•
•
EXAMPLES
A switch domain and port index pair. Use switchShow for a list of valid port
index numbers.
A world wide name (WWN).
To add members to zone aliases array1, array2, and loop1:
switch:admin> aliadd "array1", "1,2"
switch:admin> aliadd "array2", "21:00:00:20:37:0c:72:51"
SEE ALSO
aliCreate, aliDelete, aliRemove, aliShow
Fabric OS Command Reference
53-1003108-01
49
2
aliCreate
aliCreate
Creates a zone alias.
SYNOPSIS
DESCRIPTION
alicreate "aliName","member[; member...]"
Use this command to create a new zone alias. The zone alias member list must have at least one
member (empty lists are not allowed). The alias member list cannot contain another zone alias. Refer to
the zoneCreate command for more information on name and member specifications.
This command changes the defined configuration. For the change to become effective, enable the zone
configuration with the cfgEnable command. For the change to be preserved across switch reboots, save
the zone configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operands are required:
"aliName"
Specify a name for the zone alias, in double quotation marks. A zone alias name
must begin with a letter and can be followed by any number of letters, numbers,
and underscore characters. Names are case-sensitive. For example, "Ali_1" and
"ali_1" are different zone aliases. Spaces are ignored.
"member"
Specify a member or list of members to be added to the alias, enclosed in double
quotation marks. Members must be separated by semicolons. An alias member
can be specified by one or more of the following methods:
•
•
EXAMPLES
A switch domain and port index pair. Use switchShow for a list of valid port
index numbers.
A world wide name (WWN).
To create a zone alias defined by domain and port index pairs:
switch:admin> alicreate "array1", "2,32; 2,33; 2,34"
To create a zone alias with one member defined by WWN.
switch:admin> alicreate "array2", "21:00:00:20:37:0c:66:23"
SEE ALSO
50
aliAdd, aliDelete, aliRemove, aliShow
Fabric OS Command Reference
53-1003108-01
aliDelete
2
aliDelete
Deletes a zone alias.
SYNOPSIS
DESCRIPTION
alidelete "aliName"
Use this command to delete a zone alias.
This command changes the defined configuration. For the change to become effective, enable the zone
configuration with the cfgEnable command. For the change to be preserved across switch reboots, save
the zone configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operand is required:
"aliName"
Specify the name of the zone alias to be deleted. Double quotation marks are
optional.
EXAMPLES
To delete the zone alias "array2":
switch:admin> alidelete "array2"
switch:admin> alidelete array1
SEE ALSO
aliAdd, aliCreate, aliRemove, aliShow
Fabric OS Command Reference
53-1003108-01
51
2
aliRemove
aliRemove
Removes a member from a zone alias.
SYNOPSIS
DESCRIPTION
aliremove "aliName","member[; member...]"
Use this command to remove one or more members from an existing zone alias.
If all members are removed, the zone alias is deleted.
This command changes the defined configuration. For the change to become effective, enable the zone
configuration with the cfgEnable command. For the change to be preserved across switch reboots, save
the zone configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
This command has the following operands:
"aliName"
Specify the name of the zone alias from which members are to be removed in
double quotation marks. This operand is required.
"member"
Specify a member or list of members to be removed from the alias. The list must
be enclosed in double quotation marks. Members must be separated by
semicolons. An alias member can be specified by one or more of the following
methods:
•
A switch domain and port index number pair. Use switchShow for a list of
valid port index numbers.
• A world wide name (WWN)
The member list is located by an exact string match; therefore, it is important to
maintain the order when removing multiple members. For example, if a zone alias
contains"1,2; 1,3; 1,4", then removing"1,3; 1,4" succeeds but removing"1,4; 1,3"
fails.
EXAMPLES
To remove a world wide name from"array1":
switch:admin> aliremove "array1", "3,5"
switch:admin> aliremove "array1", "21:00:00:20:37:0c:76:8c"
switch:admin> aliremove "array1", "0xEF"
SEE ALSO
52
aliAdd, aliCreate, aliDelete, aliShow
Fabric OS Command Reference
53-1003108-01
aliShow
2
aliShow
Displays zone alias information.
SYNOPSIS
alishow [--ic] ["pattern"][, mode]
alishow --help
DESCRIPTION
Use this command to display zone configuration information.
Use the pattern operand to display only matching zone alias names in the defined configuration.
If no parameters are specified, all zone configuration information (both defined and effective) is
displayed. Refer to cfgShow for a description of this display.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
When invoked without an operand, this command displays all zone configuration information (defined
and effective). Refer to cfgShow for a description of this display. The following operands are optional:
--ic
Displays all configured zone alias names for a given pattern without case
distinction.
"pattern"
A POSIX-style regular expression that matches zone alias names. This operand
must be enclosed in quotation marks. Patterns may contain:
•
•
•
Question mark (?) - matches any single character.
Asterisk (*) - matches any string of characters.
Range - matches any character within the range. Ranges must be enclosed
in brackets: for example, [0-9] or [a-f].
mode
Specify 0 to display the contents of the transaction buffer (the contents of the
current transaction), or specify 1 to display the contents of the nonvolatile
memory. The default value is 0.
--help
Displays the command usage.
EXAMPLES
To display all zone aliases beginning with "arr":
switch:admin> alishow "arr*"
alias: array1 21:00:00:20:37:0c:76:8c
alias: array2 21:00:00:20:37:0c:66:23
To display all zone alias names beginning with "arr", regardless of the case:
switch:admin> alishow --ic "arr*"
alias: array1 20:e0:00:05:33:11:1f:00
alias: ARRAY2 2f:11:00:05:33:c1:37:a2
SEE ALSO
aliAdd, aliCreate, aliDelete, aliRemove
Fabric OS Command Reference
53-1003108-01
53
2
appLoginHistory
appLoginHistory
Displays the history of HTTP login sessions.
SYNOPSIS
apploginhistory --show
apploginhistory --help
DESCRIPTION
Use this command to display the history of HTTP login sessions from external management applications
such as Brocade Network Advisor or Web Tools. The command displays both current sessions and a
history of past sessions. For each entry, the command output shows the following information:
•
•
•
•
The date and time when the session started (YYYY/MM/DD-HH:MM:SS.MS).
The IP address of the machine that initiated the HTTP login.
The role of the user initiating the login.
The application initiating the login.
The history supports a maximum of 100 entries. If the history exceeds the maximum size, the oldest
entries will be removed.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--show
Displays the currently active logins and a history of past logins.
--help
Displays the command usage.
EXAMPLES
To display the application login history:
switch:admin> apploginhistory -- show
The following are history of logins to the switch from external
applications
(Login Timestamp, IP Address, User Account, Application):
2011/10/13-15:51:31.203814,
2011/10/13-15:51:33.095638,
2011/10/13-15:52:14.178299,
2011/10/13-15:52:14.643639,
2011/10/13-15:53:55.966050,
2011/10/13-15:53:56.329979,
2011/10/13-15:53:56.858216,
2011/10/13-15:53:57.547672,
10.20.10.160,
10.20.10.160,
10.20.10.161,
10.20.10.161,
10.20.10.161,
10.20.10.161,
10.20.10.161,
10.20.10.161,
admin,
admin,
admin,
admin,
admin,
admin,
admin,
admin,
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
The following are the sessions from the external applications that are
54
Fabric OS Command Reference
53-1003108-01
appLoginHistory
2
active currently:
2011/10/13-15:51:31.203814,
2011/10/13-15:51:33.095638,
2011/10/13-15:52:14.178299,
2011/10/13-15:53:57.547672,
SEE ALSO
10.20.10.160,
10.20.10.160,
10.20.10.161,
10.20.10.161,
admin,
admin,
admin,
admin,
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
DCFM-HttpConnector/null
None
Fabric OS Command Reference
53-1003108-01
55
2
aptPolicy
aptPolicy
Changes or displays the Advanced Performance Tuning (APT) policy.
SYNOPSIS
aptpolicy [policy]
aptpolicy -ap [ap_policy]
DESCRIPTION
Use this command to display and change the advanced performance tuning (APT) policies on a switch.
Several internal performance tuning parameters can be modified with this command. The default
parameters (AP shared Link Policy) are optimized for most SAN applications; in most environments,
there is no need to modify the default policy.
Distributed path selection (DPS) is supported in logical fabrics. APT policy settings affecting the DPS
behavior can be configured per logical switch, and settings apply to the partition for which they are set.
Note that policy settings for the base switch or any switch in the base fabric affect all traffic going through
the base fabric including any logical fabric traffic that uses the base fabric.
In a logical fabric environment, Link Policy settings (aptpolicy -ap) apply only to the base switch and can
be executed only on the base switch.
When invoked without arguments, this command displays the APT policies supported on this switch, as
well as the current policy.
NOTES
You must disable the switch before using this command to change the current policy. Changes take effect
immediately for all EX/VEX_Ports after the switch is re-enabled.
For details on performance tuning, refer to the Fabric OS Administrator's Guide.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
policy
Specifies the APT policy. The following polices are supported:
1
Port-based routing policy. With this policy, the path chosen for an ingress frame is
based on both of the following items:
•
•
The ingress port on which the frame was received.
The destination domain for the frame.
The chosen path remains the same if Dynamic Load Sharing (DLS) is not
enabled. If DLS is enabled, a different path may be chosen for a fabric event.
Refer to dlsSet for a definition of a fabric event.
This policy may provide better ISL utilization when there is little or no
oversubscription of the ISLs.
Note that static routes are supported only with this policy.
2
Device Based Routing Policy (FICON support only). Device-based routing is
supported in FICON environments only. With this policy, the path chosen for an
ingress frame is based on the following items:
•
•
•
56
The ingress port on which the frame was received.
The FC address of the source fabric device (SID) for this frame.
The FC address of the destination fabric device (DID) for this frame.
Fabric OS Command Reference
53-1003108-01
aptPolicy
2
This policy optimizes the utilization of the available paths by allowing I/O traffic
between different source fabric device (SID) or destination fabric device (DID)
pairs to use different paths. As a result, every distinct flow in the fabric can take a
different path through the fabric. Effectively, device based routing works the same
as exchange-based routing but does not use the Originator Exchange ID (OXID)
field. This helps to ensure that the exchanges between a pair of devices stay in
order.
Device-based routing is also a form of Dynamic Path Selection (DPS). DPS
assigns communication paths between end devices in a fabric to egress ports in
ratios proportional to the potential bandwidth of the ISL, ICL, or trunk group. When
there are multiple paths to a destination, the input traffic is distributed across the
different paths in proportion to the bandwidth available on each of the paths. This
improves utilization of the available paths and reduces possible path congestion.
3
Exchange-based routing policy (default). With this policy, the path chosen for an
ingress frame is based on all of the following items:
•
•
•
•
The ingress port on which the frame was received.
The FC address of the SID for this frame.
The FC address of the DID for this frame.
The FC OXID for this frame.
This policy optimizes the utilization of the available paths by allowing I/O traffic
between different SID, DID, or OXID pairs to use different paths. All frames
received on an ingress port with the same SID, DID, or OXID parameters take the
same path unless there is a fabric event. Refer to dlsSet for the definition of a
fabric event.
This policy does not support static routes. DLS is always enabled and the DLS
setting cannot change with this policy.
-ap ap_policy
Specifies an additional AP policy option supported under both port-based and
exchange-based policies. If logical fabrics are enabled, this command is valid only
on the base switch. The following policies are supported:
0
AP Shared Link Policy (default).
1
AP Dedicated Link Policy. This policy dedicates some links to the ingress traffic
and some links to the egress traffic. This policy relieves internal congestion in an
environment where there is a large amount of traffic going through both directions
at the same time. In addition, it can reduce the impact of slow devices on the
overall switch performance.
EXAMPLES
To display the current APT policy:
switch:admin> aptpolicy
Current Policy: 3 1(ap)
3 1 (ap): Default Policy
1: Port Based Routing Policy
2: Device Based Routing Policy (FICON support only)
3: Exchange Based Routing Policy
0: AP Shared Link Policy
1: AP Dedicated Link Policy
Fabric OS Command Reference
53-1003108-01
57
2
aptPolicy
To change the current APT policy to the AP Shared Link Policy:
switch:admin> aptpolicy -ap 0
Switch must be disabled in order to modify \
this configuration parameter. To disable the switch, \
use the "switchDisable" command.
switch:admin> switchdisable
switch:admin> aptpolicy -ap 0
Policy updated successfully.
switch:admin> switchenable
switch:admin> aptpolicy
Current Policy: 3 0(ap)
3 0(ap): Default Policy
1: Port Based Routing Policy
2: Device Based Routing Policy (FICON support only)
3: Exchange Based Routing Policy
0: AP Shared Link Policy
1: AP Dedicated Link Policy
SEE ALSO
58
dlsReset, dlsSet, dlsShow, switchDisable
Fabric OS Command Reference
53-1003108-01
auditCfg
2
auditCfg
Modifies and displays the audit log filter configuration.
SYNOPSIS
auditcfg --class audit_class
auditcfg --enable | --disable
auditcfg --severity severity_level
auditcfg --show
DESCRIPTION
Use this command to configure the audit logging and to display the audit log configuration. This
command allows you to set filters by configuring certain classes, to add or remove any of the classes in
the filter list, to set severity levels for audit messages, and to enable or disable audit filters. Based on the
configuration, certain classes are logged to syslog for auditing. Syslog configuration is required for
logging audit messages. Use the syslogdIpAdd command to add the syslogd server IP address.
NOTES
The RAS class is not configurable; its function is to audit the audit log management operations and it is
always enabled internally.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--class
Configures filters for a specified audit class. To add or remove any of the classes
in the filter list, reissue the --class option.
audit_class
Specifies the filters to be configured. Valid values are: 1-ZONE, 2-SECURITY,
3-CONFIGURATION, 4-FIRMWARE, 5-FABRIC, 6-FW (Fabric Watch), and 7-LS
(Logical Switch), 8-CLI, 9-MAPS. The filter is specified by its numeric value. To
add more than one filter, the numeric values must be separated by commas.
Spaces are not permitted. This operand is required.
--severity
Sets audit severity level to a specified value. When severity is set, only log
messages of type severity_level and higher are displayed. You cannot enter
multiple severity levels.
severity_level
Valid values are INFO, WARNING, ERROR, and CRITICAL. By default, all
messages are logged. This operand is required.
--enable
Enables all filters. This action enables an existing configuration; it does not
change the configuration.
--disable
Disables all filters.This action disables an existing configuration; it does not
change the configuration.
--show
Displays the current configuration. This operand is optional.
Fabric OS Command Reference
53-1003108-01
59
2
auditCfg
EXAMPLES
To configure the audit log filter:
switch:admin> auditcfg --class 2,3,8
Audit filter is configured.
To enable audit logging:
switch:admin> auditcfg --enable
Audit filter is enabled.
To display the configuration:
switch:admin> auditcfg --show
Audit filter is enabled.
2-SECURITY
3-CONFIGURATION
8-CLI
Severity level: INFO
To disable audit logging and to display the configuration (the filters are unchanged but show the disabled
state):
switch:admin> auditcfg --disable
Audit filter is disabled.
switch:admin> auditcfg --show
Audit filter is disabled.
2-SECURITY
3-CONFIGURATION
8-CLI
Severity level: INFO
SEE ALSO
60
auditDump, rasAdmin
Fabric OS Command Reference
53-1003108-01
auditDump
2
auditDump
Displays or clears the audit log.
SYNOPSIS
auditdump -s | -show
auditdump -c | -clear
DESCRIPTION
NOTES
OPERANDS
Use this command to display or clear the audit log on the switch. The audit log persistently saves the
most recent 256 log entries on the switch. On modular platforms, the entries are not shared across CPs.
Each CLI executed on a switch from non-root user account is saved as an audit log. To display or clear
the logs, this command must be issued for each CP separately.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-s | -show
Displays the audit log on the switch or the CP.
-c | -clear
Clears the audit log on the switch or the CP.
EXAMPLES
To display the audit log:
switch:admin> auditdump -s
0 AUDIT, 2010/02/18-01:45:52 (PDT), [SEC-3022], INFO, SECURITY,
admin/admin/10.32.220.161/http/DCFM-HttpConnec, ad_0/ras035/FID
128,, Event: logout, Status: success, Info: Successful logout
by user [admin].
1 AUDIT, 2010/02/18-01:46:00 (PDT), [SEC-3022], INFO, SECURITY,
admin/admin/10.32.220.161/http/DCFM-HttpConnec, ad_0/ras035/FID
128,, Event: logout, Status: success, Info: Successful logout
by user [admin].
2 AUDIT, 2010/02/18-01:46:18 (PDT), [SEC-3020], INFO, SECURITY,
admin/admin/10.32.220.161/http/DCFM-HttpConnec, ad_0/ras035/FID
128,, Event: login, Status: success, Info: Successful login
attempt via HTTP, IP Addr: 10.32.220.161.
3 AUDIT,2012/05/23-03:45:15 (UTC),[RAS-3005], INFO, CLI,
admin/admin/NONE/console/CLI,ad_0/McKsSpirit/CHASSIS,
CLI:clihistory
4 AUDIT,2012/05/23-04:12:04 (UTC),[RAS-3005],INFO,CLI,
admin/admin/NONE/console/CLI,ad_0/McKsSpirit/CHASSIS,
CLI:auditdump -s
(output truncated)
To clear the audit log:
switch:admin> auditdump -c
SEE ALSO
auditCfg
Fabric OS Command Reference
53-1003108-01
61
2
authUtil
authUtil
Displays and sets the authentication configuration.
SYNOPSIS
authutil
authutil --show
authutil --set option value
authutil --policy -sw option | -dev option
authutil --authinit [slot/]port[, [slot/]port...] | allE
DESCRIPTION
Use this command to display and set local switch authentication parameters.
Use --set to change authentication parameters such as protocol, Diffie-Hellman group (DH group), or
hash type. When no protocol is set, the default setting of "FCAP, DH- CHAP" is used. When no group is
set, the default setting of "*" (meaning "0,1,2,3,4") is used. Configuration settings are saved persistently
across reboots. Configuration changes take effect during the next authentication request.
Use the --show command to display the current authentication configuration.
Authentication parameters are set on a per-switch basis. If Virtual Fabrics are enabled, all authentication
parameters apply to the current logical switch context only, and must be configured separately for each
logical switch. Use setContext to change the current logical switch context.
In a VF environment, authentication is performed only on physical E_Ports, not on logical interswitch
links (LISLs).
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--show
Displays the local authentication configuration.This option is supported in the
Access Gateway (AG) mode.
--set option value
Modifies the authentication configuration. Valid options and their values include
the following:
-a fcap | dhchap | all
Sets the authentication protocol. Specify "fcap" to set only FCAP authentication.
Specify "dhchap" to set only DH-CHAP authentication. Specify "all" to set both
FCAP and DH-CHAP, which is the default setting. When authentication is set to
"all", the implicit order is FCAP followed by DH-CHAP. This means that in
authentication negotiation, FCAP is given priority over DH-CHAP on the local
switch. If the negotiation is done for an encrypted port, DHCHAP takes
precedence over FCAP. The --set dhchap and --set all options are supported in
the AG mode.
-g 0 | 1 | 2 | 3 |4 | *
Sets the Diffie-Hellman (DH) group. Valid values are 0 to 4 and "*". The DH group
0 is called NULL DH. Each DH group implicitly specifies a key size and associated
parameters. A higher group value provides stronger cryptography and a higher
level of security. When DH group is set to a specified value, only that DH group is
62
Fabric OS Command Reference
53-1003108-01
authUtil
2
enabled. Specifying "*" enables all DH groups 0, 1, 2, 3, and 4, in that order. This
means that in authentication negotiation, the NULL DH group is given priority over
all other groups. In the case of a port that is enabled for encryption and you
specify "*", the DH group 4 is selected.This option is supported in AG mode.
-h sha1 | sha256 | md5 | all
Sets the hash type. Valid values are "sha1", "sha256", "md5", or "all". When set to
"all", md5 and sha1 hash types are set. Use this option to disable md5
authentication access by setting the hash type to sha1. Enabling sha256 access
is required when configuring the system for FIPS. Refer to the Fabric OS
Administrator's Guide for details on FIPS configuration. This option is supported in
AG mode.
--policy
Sets the switch authentication policy or device authentication policy. The following
options are supported:
-sw on |off | active | passive
Sets the switch authentication policy. Specify one of the following modes.
Operands are exclusive. If the switch has ports enabled for encryption, only the
ON and ACTIVE options are supported. Only on and off options are supported in
AG mode.
on
Sets the switch authentication policy to ON mode. Strict authentication is
enforced on all E_Ports. The interswitch link (ISL) goes down (port disable), if
the connecting switch does not support the authentication or the
authentication policy is switched off.
off
Turns the authentication policy off, and the switch rejects any authentication
requests.
active
Sets the authentication policy to active mode. During switch initialization,
authentication is initiated on all E_Ports, but the port is not disabled if the
connecting switch does not support authentication or the authentication policy
is turned off.
passive
Sets the authentication policy to passive mode (default) . The switch does not
initiate authentication but participates in authentication if the connecting
switch initiates authentication.
-dev off | passive | on
Sets the device authentication policy. Three modes are supported. Device
authentication policy is off by default. This option and suboptions are supported in
AG mode.
off
Turns off the device authentication policy. Authentication is not required. The
switch ignores any authentication requests and continues with the FC probing
without authentication.
passive
Sets the authentication policy to passive mode. Authentication is optional. If
the attached device is capable of doing the authentication then the switch
participates in authentication; otherwise it forms an F_Port without
authentication. In this mode the device accepts authentication on all F_Ports.
Fabric OS Command Reference
53-1003108-01
63
2
authUtil
on
Sets the authentication policy to "on" mode. Authentication is mandatory. If
the attached device is not capable of doing authentication, the corresponding
port is disabled.
--authinit [slot/]port [, [slot/]port...| allE
Reinitiates authentication on selected ports after changing the DH-CHAP group,
hash type, and shared secret between a pair of switches. This command does not
work on Private, Loop, NPIV and FICON devices. This command may bring down
the E_Ports if the DH-CHAP shared secrets are not installed correctly. This
command is not supported on encrypted ports. This option is not supported in AG
mode. Valid options include the following:
slot
Specify the slot number, if applicable, followed by a slash (/).
port
Specify the port number. On enterprise-class platforms, use the slot/port format for
specifying the port number.
allE
Specify all E_Ports in the switch.
EXAMPLES
To set DH-CHAP as the authentication protocol:
switch:admin> authutil --set -a dhchap
Authentication is set to dhchap.
To set both protocols in order of FCAP and then DH-CHAP:
switch:admin> authutil --set -a all
Authentication is set to fcap,dhchap.
To enable sha1 hash type:
switch:admin> authutil --set -h sha1
Hash is set to sha1.
To enable all hash types:
switch:admin> authutil --set -h all
Hash is set to sha1,md5.
To check the hash types set:
switch:admin> authutil --show
AUTH TYPE
HASH TYPE
GROUP TYPE
-------------------------------------fcap,dhchap
sha1,md5
1
Switch Authentication Policy: PASSIVE
Device Authentication Policy: OFF
64
Fabric OS Command Reference
53-1003108-01
authUtil
2
To enable Sha256 hash type:
sha256 hash type is recommended only for FIPS configuration.
switch:admin> authutil --set -h sha256
Hash is set to sha256.
switch:admin> authutil --show
AUTH TYPE
HASH TYPE
GROUP TYPE
-------------------------------------fcap,dhchap
sha256
1
Switch Authentication Policy: PASSIVE
Device Authentication Policy: OFF
To set DH group 3:
switch:admin> authutil --set -g 3
DH Group was set to 3.
To set all DH groups to be specified in the authentication negotiation in the order of 0, 1, 2, 3, and 4:
switch:admin> authutil --set -g
DH Group is set to 0,1,2,3,4
"*"
To set the Switch policy to active mode:
switch:admin> authutil --policy -sw active
Warning: Activating the authentication policy requires
either DH-CHAP secrets or PKI certificates depending
on the protocol selected. Otherwise, ISLs will be
segmented during next E-port bring-up.
ARE YOU SURE (yes, y, no, n): [no] y
Auth Policy is set to ACTIVE
To set the Device policy to passive mode:
switch:admin> authutil --policy -dev passive
Warning: Activating the authentication policy requires
DH-CHAP secrets on both switch and device. Otherwise,
the F-port will be disabled during next F-port
bring-up.
ARE YOU SURE (yes, y, no, n): [no] y
Device authentication is set to PASSIVE
To set the device authentication policy to "on" mode:
switch:admin> authutil --policy -dev on
Warning: Activating the authentication policy requires
DH-CHAP secrets on both switch and device. Otherwise,
the F-port will be disabled during next F-port
bring-up.
ARE YOU SURE (yes, y, no, n): [no] y
Device authentication is set to ON
2008/03/24-23:13:06, [AUTH-1003], 112,, INFO, Stealth_3,
Device authentication type has been successfully set to ON
Fabric OS Command Reference
53-1003108-01
65
2
authUtil
To start authentication on E/F_Ports 2, 3, and 4:
switch:admin> authutil --authinit 2,3,4
Warning: Initiating the authentication requires either DH-CHAP
secrets or PKI certificates depending on the protocol selected.
Failed authentication may result in traffic disruption.
Authentication will not be initiated on encrypted ports.
ARE YOU SURE (yes, y, no, n): [no]y
SEE ALSO
66
portShow, secAuthSecret
Fabric OS Command Reference
53-1003108-01
bannerSet
2
bannerSet
Sets the banner on the local switch.
SYNOPSIS
DESCRIPTION
bannerset [banner]
Use this command to set the banner on the local switch.
The banner is a string of alphanumeric characters. It is displayed after you log in to a switch.
The banner can be created using the banner operand or interactively by entering the bannerSet
command without an operand.
If you enter the banner text using the interactive method, the valid length is 1022 characters. If the
banner text length exceeds the maximum allowed, the software truncates the input. To close the banner
text string, enter a period at the beginning of a new line.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following optional operand:
banner
Specify a text string to be displayed upon login. If you enter the banner text using
the banner operand, the valid length is 116 characters.
EXAMPLES
To set a new banner for a switch:
switch:admin> bannerset "My banner"
switch:admin> bannerSet
Please input context of security banner (press "." RETURN \
at the beginning of a newline to finish input):
SEE ALSO
bannerShow, motd
Fabric OS Command Reference
53-1003108-01
67
2
bannerShow
bannerShow
Displays the banner text.
SYNOPSIS
DESCRIPTION
NOTES
bannershow
Use this command to display the text of the local switch banner.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the banner for a switch:
switch:admin> bannershow
Banner: Do not disturb the setup on this switch.
SEE ALSO
68
bannerSet, motd
Fabric OS Command Reference
53-1003108-01
bcastShow
2
bcastShow
Displays broadcast routing information.
SYNOPSIS
DESCRIPTION
bcastshow
Use this command to display the broadcast routing information for all ports in the switch. The broadcast
routing information indicates all ports that are members of the broadcast distribution tree: ports that are
able to send and receive broadcast frames.
Normally, all F_Ports and FL_Ports are members of the broadcast distribution tree. The broadcast path
selection protocol selects the E_Port members of this tree in a manner designed to prevent broadcast
routing loops.
The following fields are displayed:
Group
The multicast group ID of the broadcast group (always 256).
Member Fx_Ports
A map of all F_Ports and FL_Ports ports in the broadcast tree.
Member E_Ports
A map of all E_Ports in the broadcast tree.
The broadcast routing information for the ports is displayed as a set of hexadecimal bit maps. Each bit in
a bit map represents a port, with the least significant bit in each row representing port 0, 32, 64, and so
on.
NOTES
The output from this command may vary depending on the hardware platform.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the broadcast routing information for all ports in the switch:
switch:admin> bcastShow
Group Member Ports
Member ISL Ports
---------------------------------------256
0x00012083
0x00002080
0x00000440
0x00000400
0x00770000
0x00700000
0x00008200
0x00000000
0x00000001
0x00000000
In this example from a switch with 128 ports, the member ports consist of ports 7, 13, 42, 84, 85, and 86.
The final Member Ports bit set represents the embedded port (frames sent to be handled by
firmware).and is typically set.
SEE ALSO
portRouteShow
Fabric OS Command Reference
53-1003108-01
69
2
bladeCfgGeMode
bladeCfgGeMode
Configures a GbE port or a 10GbE port on the Brocade FX8-24 blade.
SYNOPSIS
bladecfggemode --set mode -slot slot
bladecfggemode --show -slot slot | -all
bladecfggemode --help
DESCRIPTION
NOTES
Use this command to configure the GbE port mode on the Brocade FX8-24 extension blade or to display
the configuration. The mode configuration controls which ports are enabled.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command is supported only on the Brocade FX8-24 blade in a DCX or DCX-S4 chassis.
OPERANDS
This command has the following operands:
--set mode
Sets the GbE port mode for a specified slot. Valid modes are one of the following:
1g
Enables the GbE ports ge0-ge9 (xge0 and xge1 are disabled).
10g
Enables the GbE ports xge0 and xge1 (ge0-ge9 ports are disabled).
dual
Enables the GbE ports ge0-ge9 and xge0 (xge1 is disabled).
-slot slot
Specifies the slot number for the FX8-24 blade. This operand is required when
setting the GbE port mode
--show
Displays the GbE port mode for the specified slots.
-slot slot
Displays the GbE port mode for a single slot.
-all
Displays the GbE port mode for all configured slots.
--help
Displays the command usage.
EXAMPLES
To configure the Brocade FX8-24 blade in slot 4 in 1G mode:
switch:admin> bladecfggemode --set 1g -slot 4
To display the GbE port mode for the Brocade FX8-24 blade in slot 4:
switch:admin> bladecfggemode --show -slot 4
bladeCfgGeMode: Blade in slot 4 is configured in 10GigE Mode
10GigE mode: only xge0 and xge1 are enabled (ge0-9 ports \
are disabled)
70
Fabric OS Command Reference
53-1003108-01
bladeCfgGeMode
2
To display the GbE port mode for all configured slots:
switch:admin> bladecfggemode --show -all
bladeCfgGeMode: Blade in slot 1 is configured in 1GigE Mode
1GigE mode: only the ge0-9 ports are enabled (xge0 and xge1 \
are disabled)
bladeCfgGeMode: Blade in slot 4 is configured in 10GigE Mode
10GigE mode: only xge0 and xge1 are enabled (ge0-9 ports \
are disabled)
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
71
2
bladeDisable
bladeDisable
Disables all user ports on a blade.
SYNOPSIS
DESCRIPTION
bladedisable slot
Use this command to disable all user ports on a blade. All Fibre Channel ports on the blade are taken
offline. If the switch was connected to a fabric through this blade, the remaining switches reconfigure,
and the switch reconfigures based on the other blade ports. As each port is disabled, the front panel LED
changes to a slow-flashing amber.
After issuing bladeDisable on a slot in a chassis, switchShow displays the user ports in the disabled
state. The blade is still shown as enabled in both switchShow and slotShow output.
The blade must be disabled before making configuration changes or before running many of the
diagnostic tests. The blade does not need to be disabled before rebooting or powering off.
You cannot disable a blade when the blade is faulted, powered off, or running diagnostics.
This command disables the ports on a single blade. To disable the ports in an entire chassis, use the
chassisDisable command.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
slot
Specifies the slot number for the ports to be disabled.
EXAMPLES
To disable a blade in slot 5:
switch:admin> bladedisable 5
Blade 5 is being disabled...Done
To verify that the user ports on the blade are disabled:
switch:admin> switchshow -slot 5
switchName:
DCX57_9
switchType:
62.1
switchState:
Online
switchMode:
Native
switchRole:
Subordinate
switchDomain:
9
switchId:
fffc09
switchWwn:
10:00:00:05:1e:40:4a:00
zoning:
ON (all_cfg)
switchBeacon:
OFF
FC Router:
OFF
FC Router BB Fabric ID: 128
Slot
Blade Type
ID
Model Name
Status
----------------------------------------------------5
COREBLADE
52
CORE8
ENABLED
Index Slot Port Address Media Speed State
Proto
===================================================
384
5
0
-----cu
8G
In_Sync
FC Disabled
72
Fabric OS Command Reference
53-1003108-01
bladeDisable
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
SEE ALSO
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
------------------------------------------------------------------------------------------------------------------------------------------------------------
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
cu
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
8G
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
In_Sync
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
FC
2
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
Disabled
bladeEnable, chassisDisable, chassisEnable, portDisable, portEnable, slotShow, switchEnable,
switchDisable, switchShow
Fabric OS Command Reference
53-1003108-01
73
2
bladeEnable
bladeEnable
Enables all user ports on a blade.
SYNOPSIS
DESCRIPTION
bladeenable slot
Use this command to enable all user ports on a blade. All ports within the blade that did not fail the
power-on self-test (POST) are enabled (except for persistently disabled ports). They may come online if
connected to a device, or remain offline if disconnected. Use the bladeEnable command to re-enable
the blade after making configuration changes or running offline diagnostics.
If the switch is connected to a fabric through previously disabled ports, it rejoins the fabric. If this switch
remains the principal switch at the end of the fabric countdown, it assigns itself a domain ID. If another
switch assumes the principal role, the re-enabled switch becomes a subordinate switch and accepts a
domain ID from the principal.
As each port is enabled, the front panel LED changes from a slow-flashing amber to nonflashing green
for online ports or to nonflashing amber for ports that do not initialize. Disconnected ports remain unlit.
NOTES
You cannot disable a single blade when the entire chassis is disabled, or when the blade itself is faulted,
powered off, or running diagnostics. Use chassisEnable to enable the ports on an entire chassis.
Persistently disabled ports are not enabled by this command.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
slot
Specifies the slot number to be enabled.
EXAMPLES
To display the slot status, enable the user ports in slot 4, and verify the settings:
switch:admin> slotshow
Slot
Blade Type
ID
Status
--------------------------------1
SW BLADE
2
ENABLED
2
UNKNOWN
VACANT
3
UNKNOWN
VACANT
4
SW BLADE
2
ENABLED (User Ports Disabled)
5
CP BLADE
1
ENABLED
6
CP BLADE
1
ENABLED
7
SW BLADE
2
ENABLED
8
UNKNOWN
VACANT
9
UNKNOWN
VACANT
10
UNKNOWN
VACANT
switch:admin> bladeenable 4
Blade 4 is being enabled...Done
switch:admin> slotshow
Slot
Blade Type
ID
Status
--------------------------------1
SW BLADE
2
ENABLED
2
UNKNOWN
VACANT
74
Fabric OS Command Reference
53-1003108-01
bladeEnable
3
4
5
6
7
8
9
10
SEE ALSO
UNKNOWN
SW BLADE
CP BLADE
CP BLADE
SW BLADE
UNKNOWN
UNKNOWN
UNKNOWN
2
1
1
2
2
VACANT
ENABLED
ENABLED
ENABLED
ENABLED
VACANT
VACANT
VACANT
bladeDisable, chassisDisable, chassisEnable, portEnable, portDisable, switchDisable,
switchShow
Fabric OS Command Reference
53-1003108-01
75
2
bladeSwap
bladeSwap
Swaps the area numbers for matching port pairs of two blades.
SYNOPSIS
DESCRIPTION
bladeSwap -src source_slot -dest destination_slot
Use this command to swap the area numbers for matching port pairs of two blades. All ports must qualify
for swapping for this command to succeed. It validates that the blades in the indicated slots are of the
same type, have the same number of ports, and that the port pairs are in the same partition.
If all the ports qualify for swapping, this command automatically performs the following operations:
1.
It enables the port swapping feature by executing the portSwapEnable command.
2.
It takes all ports on both the source and destination blades offline by executing the bladeDisable
command.
3.
It swaps the matching port pairs on each of the specified blades.
4.
It re-enables the blade by executing the bladeEnable command.
The result of this operation is persistent across reboots and power cycles.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command leaves both the source and destination blades in a disabled state. To enable all ports on a
blade, issue the bladeEnable command. To enable individual ports, issue the portEnable command.
This command affects port swap information that is kept in its own database. It cannot be manipulated by
editing the configuration database reported by configShow.
This command is not allowed if one or both the blades are faulty.
OPERANDS
This command has the following operands:
-src source_slot
Specifies the slot number for the source blade.
-dest destination_slot
Specifies the slot number for the destination blade. Use slotShow for a listing of
valid slots.
EXAMPLES
To swap area numbers between matching port pairs of two slots:
switch:admin> bladeswap -src 1 -dest 3
bladeswap done
SEE ALSO
76
portSwapEnable, portSwapDisable, portSwapShow, portShow, portEnable, portDisable,
bladeEnable, bladeDisable, switchShow, switchEnable
Fabric OS Command Reference
53-1003108-01
bootLunCfg
2
bootLunCfg
Transparently configures the boot LUN for an HBA.
SYNOPSIS
bootluncfg --add HBA_WWN PWWN LUN_ID
bootluncfg --delete HBA_WWN [PWWN LUN_ID]
bootluncfg --show
bootluncfg --help
DESCRIPTION
Use this command to configure the boot LUN for an HBA.
Existing fabric-based boot LUN discovery allows the host's boot LUN information to be stored in the
fabric zone database by using a zone name that contains the PWWN of an HBA port. The zone members
consist of storage target PWWN and LUN ID.
This command provides a simplified and transparent procedure for configuring the boot LUN. Once
configured, the HBA boot code queries the zone member list for the zone name matching the HBA
PWWN to determine the boot target and LUN.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
HBA_WWN
Specifies the WWN of the HBA port connecting to the boot LUN. This is a
hexadecimal number, for example, 10:00:00:000:05:1e:41:9a:cb.
PWWN
Specifies the WWN of the remote storage target's port. For example,
50:00:00:05:1e:41:9a:ca. This operand is required with the --add option and
optional with the --delete option.
LUN_ID
Specifies the hexadecimal LUN identification. The LUN ID is represented as an
eight-byte value (four-level LUN addressing), for example,
09AABBCCDDEEFF00. This operand is required with the --add option and
optional with the --delete option.
--add
Configures the specified HBA (HBA_WWN) to boot from the specified LUN
(LUN_WWN) accessible through the Target PWWN (PWWN).
--delete
Removes the mapping for the HBA (HBA_PWWN) to boot from the LUN (LUN_ID)
accessible through the Target Port (PWWN).
--show
Displays all configured HBA to Port/LUN Mappings.
--help
Displays the command usage.
Fabric OS Command Reference
53-1003108-01
77
2
bootLunCfg
EXAMPLES
To configure a boot LUN:
switch:admin> bootluncfg --add 11:22:ab:44:44:ff:44:ca \
1b:6c:55:55:55:3a:55:ff 9abc345fa1112410
Operation Successful
To display existing Port/LUN mappings:
switch:admin> bootluncfg --show
00:11:22:33:44:55:66:77
00:00:00:00:aa:bb:cc:dd;00:00:00:01:ee:ff:11:22; \
00:00:00:02:9a:bc:34:5f;00:00:00:03:a1:11:24:10
aa:aa:aa:aa:aa:aa:aa:aa
00:00:00:00:11:11:11:11;00:00:00:01:11:11:11:11; \
00:00:00:02:9a:bc:34:5f;00:00:00:03:a1:11:24:10
bb:aa:aa:aa:aa:aa:aa:aa
00:00:00:00:11:11:11:11;00:00:00:01:11:11:11:11; \
00:00:00:02:9a:bc:34:5f;00:00:00:03:a1:11:24:10
To remove an HBA to Port/LUN mapping:
switch:admin> bootluncfg --delete 11:22:ab:44:44:ff:44:ca \
1b:6c:55:55:55:3a:55:ff 9abc345fa1112410
Operation Successful
SEE ALSO
78
None
Fabric OS Command Reference
53-1003108-01
bottleneckMon
2
bottleneckMon
Monitors and reports latency and congestion bottlenecks on F_Ports and E_Ports.
SYNOPSIS
bottleneckmon --enable [-cthresh congestion_threshold]
[-lthresh latency_threshold] [-time seconds]
[-qtime seconds] [-alert | -alert=congestion |
-alert=latency | -noalert]
[-lsubsectimethresh time_threshold]
[-lsubsecsevthresh severity_threshold]
bottleneckmon --disable
bottleneckmon --config [-cthresh congestion_threshold]
[-lthresh latency_threshold][-time seconds]
[-qtime seconds] [-alert | -alert=congestion |
-alert=latency | -noalert]
[-lsubsectimethresh time_threshold]
[-lsubsecsevthresh severity_threshold]
[[slot/]port_list]
bottleneckmon --configclear [slot/]port_list
bottleneckmon --exclude [slot/]port_list
bottleneckmon --include [slot/]port_list
bottleneckmon --show [-interval seconds] [-span seconds]
[-refresh][-congestion | -latency] [[slot/]port | '*']
bottleneckmon --status
bottleneckmon --cfgcredittools -intport -recover
[off | onLrOnly | onLrThresh] [-lrthresh threshold]
-fault [edgeblade | coreblade | edgecoreblade]
bottleneckmon --cfgcredittools -intport -check slot/blade_port,VC
bottleneckmon --linkreset slot/blade_port
bottleneckmon --showcredittools
bottleneckmon --help
DESCRIPTION
Use this command to (1) detect latency and congestion bottlenecks on F[L]_Ports and E_Ports and (2) to
manage credit recovery on backend ports. Bottleneck detection and credit recovery are two independent
functions; enabling credit recovery has no impact on bottleneck detection and vice versa.
Bottleneck Detection
For bottleneck detection, this command provides the following management functions:
•
Enabling or disabling bottleneck detection on a switch and optionally configuring thresholds and alert
parameters.
•
Changing alert parameters on specified ports after you have enabled the feature on the switch.
Fabric OS Command Reference
53-1003108-01
79
2
bottleneckMon
•
Configuring severity thresholds for congestion and latency bottlenecks for a switch or for a specified
port list.
•
•
Configuring for congestion and/or latency bottlenecks for a switch or for a specified port list.
•
•
•
Clearing the configuration on specified ports only (this option cannot be performed switch-wide).
Refining the criterion for defining latency bottleneck conditions to allow for more (or less) sensitive
monitoring at the sub-second level.
Excluding specified ports from being monitored or including previously excluded ports.
Generating history or status reports that show congestion bottlenecks and latency bottlenecks.
Enabling or disabling bottleneck detection is a switch-wide operation. If Virtual Fabrics are enabled, the
configuration is applied per logical switch and affects all ports on the current logical switch. After the
(logical) switch-wide bottleneck detection parameters have been set, you can you can fine-tune the
configuration for specific ports.
A bottleneck is defined as a condition where the offered load at a given port exceeds the throughput at
the port. This command supports detection of two types of bottleneck conditions: congestion and latency.
•
A congestion bottleneck arises from link over-utilization. This happens when the offered load
exceeds throughput and throughput is at 100%. Frames attempt to egress at a faster rate than the
line rate allows. Link utilization is measured once every second at the port. When trunked ports are
monitored, link utilization is measured for the entire trunk. A congestion bottleneck is assumed if the
utilization during the measured second is 95% or more.
•
A latency bottleneck occurs when egress throughput at a port is lower than the offered load because
of latency in the return of credits from the other end of the link. This is not a permanent condition.
The offered load exceeds throughput and throughput is less than 100%. In this case, the load does
not exceed the physical capacity of the channel as such, but can occur because of an
underperforming device connected to the F_Port, or because of back pressure from other
congestion or latency bottlenecks on the E_Ports. Bottleneck detection can help identify these
devices and pinpoint the upstream bottlenecks caused by these devices inside the fabric.
When bottleneck detection is enabled on a switch and you specify an alert, the command triggers an
SNMP and a RASlog alert when the ports on the configured switch experience latency or congestion.
Another alert is sent after the condition resolves. For a given averaging time, each second is marked as
affected by latency and/or congestion or not. If the number of affected seconds crosses the configured
threshold, an alert is triggered for the port. You can configure alerts for latency, for congestion, or both.
You can also configure a severity threshold for each type of bottleneck and the time interval over which
the bottlenecks are measured.
For example, setting a latency threshold of 0.8 and a time window of 30 seconds specifies that an alert
should be sent when 80% of the one-second samples over any period of 30 seconds were affected by
latency bottleneck conditions. The -qtime option can be used to throttle alerts by specifying the minimum
number of seconds between consecutive alerts. Thresholds are configured separately for each type of
bottleneck and statistical data are collected independently for each condition. The -qtime parameter
applies to both types of bottleneck detection; there can be one latency alert and one congestion alert in a
configured quiet time.
Bottleneck detection works both in non-Virtual Fabric mode and in Virtual Fabric Mode. If Virtual Fabrics
are enabled, bottleneck detection is configured per logical switch. If a port is removed from a logical
switch after bottleneck detection is enabled on the logical switch, the configuration is retained in that
logical switch. If the port is added again to the same logical switch, bottleneck detection is automatically
re-enabled for this port using the retained configuration. This feature allows you to configure more than
one logical switch to perform bottleneck detection on the same port, although only one logical switch
performs the operation on the port at any given time.
The --show option displays a history of the bottleneck severity for a specified port or for all ports. Each
line of output shows the percentage of one-second intervals affected by bottleneck conditions during the
time window shown on that line. When issued for all ports, the union of all port statistics is displayed in
addition to individual port statistics. The union value provides a good indicator for the overall bottleneck
80
Fabric OS Command Reference
53-1003108-01
bottleneckMon
2
severity on the switch. You can filter the output to display only latency or congestion bottleneck statistics.
When used without port operand the command displays the number of ports affected by bottleneck
conditions. A "bottlenecked" port in this output is defined as any port that was affected by a bottleneck for
one second or more in the corresponding interval.
When using the --show command, you may see a "no data for x seconds" or "no data" message
displayed at the end of a line of output. The "no data..." message in any interval means that there was no
data to analyze for the stated number of seconds or for the entire interval if the remark is simply "no
data." This typically means that there was no traffic on the link for the stated number of seconds. The
percentage of affected seconds displayed takes this into account. For example, if there was no traffic for
6 seconds in an interval of 10 seconds, and 1 second out of the other 4 seconds was affected by a
bottleneck, the display for that interval would show 25% as the percentage of affected seconds (1 out of
4), and state "no data for 6 seconds." However, if there is no traffic because the port is offline, the "no
data..." message is displayed.
The --status option displays bottleneck configuration details for the current (logical) switch. If virtual
fabrics are enabled, ports not belonging to the current logical switch are not displayed. The command
output includes the following information:
Bottleneck detection
Enabled or disabled
Switch-wide sub-second latency bottleneck criterion
Displays the following parameters:
Time threshold
The value set with the -lsubsectimethresh operand.
Severity threshold
The value set with the -lsubsecsevthresh operand.
Switch-wide alerting parameters
Displays the following parameters:
Alerts?
Yes (enabled), No (disabled), Congestion only, or Latency only.
Congestion threshold for alert
The severity threshold for triggering a congestion alert. This threshold indicates
the percentage of one-second intervals affected by congestion conditions within a
specified time window. The congestion threshold is expressed as a fraction
between 0 and 1.
Latency threshold for alert
The severity threshold for triggering a latency alert. This threshold indicates the
percentage of one-second intervals affected by latency conditions within a
specified time window. The latency threshold is expressed as a fraction between 0
and 1.
Averaging time for alert
The time window in seconds over which the percentage of seconds affected by
bottleneck conditions is computed and compared with the threshold.
Quiet time for alert
The minimum number of seconds between consecutive alerts. The value
assigned to this parameter applies to both latency and congestion detection.
Per-port overrides for sub-second latency bottleneck criterion
Custom configuration for the above mentioned sub-second latency bottleneck
parameters. Note that everything above this line applies to all ports in the switch
that don't have any custom configuration or exclusions.
Fabric OS Command Reference
53-1003108-01
81
2
bottleneckMon
Per-port overrides for alert parameters
Custom configuration for the above mentioned alert parameters. The
abbreviations "C" and "L" indicate "congestion" and "latency" alerts. "Y" means
alerts are enabled for both types, and "N" means alerts are disabled.
Excluded ports
List of ports excluded from bottleneck detection.
Credit recovery on backend ports
Use the --cfgcredittools commands to enable or disable credit recovery of backend ports and to display
the configuration. When this feature is enabled, credit is recovered on backend ports (ports connected to
the core blade or core blade backend ports) when credit loss has been detected on these ports. If
complete loss of credit on a Condor2 backend port causes frame timeouts, a link reset will be performed
on that port regardless of the configured setting, even if that setting is -recover off. When used with the
-recover onLrOnly option, the recovery mechanism takes the following escalating actions:
•
•
When it detects credit loss, it performs a link reset and logs a RASlog message (RAS Cx-1014).
•
•
If the port fails to reinitialize, the port is faulted. A RASlog message (RAS Cx-1016) is generated.
If the link reset fails to recover the port, the port reinitializes. A RASlog message is generated (RAS
Cx-1015). Note that the port reinitialization does not fault the blade.
If a port is faulted and there are no more online backend ports in the trunk, the core blade is faulted.
(Note that the port blade will always be faulted). A RASlog message is generated (RAS Cx-1017).
When used with the -recover onLrThresh option, recovery is attempted through repeated link resets
and a count of the link resets is kept. If the threshold of more than two link resets per hour is reached, the
blade is faulted (RAS Cx-1018). Note that regardless of whether the link reset occurs on the port blade or
on the core blade, the port blade is always faulted.
If you suspect complete credit loss on a particular virtual channel (VC) on a particular backend port, use
the -check option to examine that particular backend port and VC for credit loss. If the command detects
complete credit loss, it reports the information. If, in addition, you have enabled link resets on backend
ports, this command will perform a link reset on the link in an attempt to recover from the problem. You
must explicitly initiate this check and it is a one-time operation. In other words, this command does not
continuously monitor for credit loss in the background. Detection of credit loss takes 2-7 seconds, after
which the results of the operation are displayed. A Link Reset also generates a RASlog message.
For more information on the RASlog messages, refer to the Fabric OS Message Reference.
NOTES
Command syntax predating Fabric OS v6.4.0 is no longer supported as of Fabric OS v7.0.0.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The bottleneck detection commands are supported on F_Ports, FL_Ports, E_Ports, and EX_Ports.
The credit recovery commands are supported only on backend ports of Condor, Condor 2, and Condor
3-based blades in the Brocade DCX 8510-8 and DCX 8510-4 chassis.
The -check option is supported only on modular switches, and only on links between Condor 2 core
blades and Condor 2 port blades. AP blades are not supported.
All credit recovery-related options are also available with the creditRecovMode command as of Fabric
OS v7.2.0.
All credit recovery options will be deprecated from the bottleneckMon command in a future Fabric OS
release because these options are already made available in the creditRecovMode command.
82
Fabric OS Command Reference
53-1003108-01
bottleneckMon
OPERANDS
2
Bottleneck detection commands
The following operands support bottleneck detection:
slot
On bladed systems only, specifies the slot number of the ports to be configured,
followed by a slash (/).
port_list
Specifies one or more ports, relative to the slot on bladed systems. Use
switchShow for a listing of valid ports. The --show option allows only a single
port or all ports ('*') to be specified with this command, unless it is used without
port operand. A port list should be enclosed in double quotation marks and can
consist of the following:
•
•
•
•
A single port, for example, "8" or "5/8" on blades systems.
A port range where beginning and end port are separated by a dash, for
example, "8-13" or "5/8-13" on blades systems. A port range cannot span
multiple slots.
A set of ports, separated by a space, for example "3 5 7 8"or 5/3 5 7 8 on
bladed systems.
A wildcard ('*') indicates all ports. The wildcard must be enclosed in single
quotation marks and is not allowed with the --config option. To make
switch-wide changes, use --config without a port specifier.
--enable
Enables bottleneck detection on the switch. This operation is switch-wide and
affects all F[L]_Ports and F_Ports. This operation enables bottleneck detection on
all eligible ports of a switch, no matter when they become eligible. If you have
Virtual Fabrics enabled and you move ports into a bottleneck enabled logical
switch from another logical switch, bottleneck detection is enabled upon
completion of the move. You can configure optional thresholds and alerts when
you enable the feature, or you can change selected parameters later with the
--config command.
--config
Modifies bottleneck detection parameters on specified ports or, when a port list is
not specified, on the entire switch. Bottleneck detection must first be enabled
before you can fine-tune the configuration with the --config command. The history
of bottleneck statistics thus far will not be lost for the specified ports and can be
viewed with the --show option. However, alert calculations restart on the specified
ports when parameters change. This operation is allowed on excluded ports.
The following parameters can be optionally set with the --enable and --config
commands. Any numerical parameters not specified with the --config option will
retain the current configured values. Whereas, any parameters not specified with
the --enable option will assume their default values.
-alert
Enables both congestion and latency alerts. You can optionally specify either a
congestion threshold or a latency threshold, or both. This operand is optional; if
omitted, the alerts are disabled. To retain the current alert configuration, you must
specify the -alert options for every --config operation.
-alert=congestion
Enables congestion alerts only. You can optionally specify a congestion threshold
for this type of alert. Latency thresholds are not valid.
-alert=latency
Enables latency alerts only. You can optionally specify a latency threshold for this
type of alert. Congestion thresholds are not valid.
Fabric OS Command Reference
53-1003108-01
83
2
bottleneckMon
When you specify one of the three alert options, the following parameters become
available, although the threshold options are subject to the restrictions stated
above.
-cthresh congestion_threshold
Specifies the severity threshold for congestion that triggers an alert. The
threshold indicates the percentage of one-second intervals affected by the
bottleneck condition within the specified time window. The threshold is
expressed as the equivalent fraction between 0 and 1. The default value is
0.8.
-lthresh latency_threshold
Specifies the severity threshold for latency that triggers an alert. The
threshold indicates the percentage of one-second intervals affected by the
bottleneck condition within the specified time window. The threshold is
expressed as the equivalent fraction between 0 and 1. The default value is
0.1.
-time window
Specifies the time window in seconds over which the percentage of seconds
affected by bottleneck conditions is computed and compared with the
threshold. The maximum window size is 10800 seconds (3 hours). The
default is 300 seconds. This parameter is valid with all three alert options.
-qtime quiet_time
Specifies the minimum number of seconds between consecutive alerts. The
default is 300 seconds. The maximum is 31556926 seconds (approximately
one year). This parameter is valid with all three alert options.
-noalert
Disables alerts. This is the default state assumed if neither -alert nor -noalert is
specified.
-lsubsectimethresh time_threshold
Sets the threshold for latency bottlenecks at the sub-second level. The
time_threshold specifies the minimum fraction of a second that must be affected
by latency in order for that second to be considered affected by a latency
bottleneck. For example, a value of 0.75 means that at least 75% of a second
must have had latency bottleneck conditions in order for that second to be
counted as an affected second. The time threshold value must be greater than 0
and no greater than 1. The default value is 0.8. Note that the application of the
sub-second numerical limits is approximate. This command erases the statistics
history and restarts alert calculations (if alerting is enabled) on the specified ports.
When used with the config option, you must specify a port.
-lsubsecsevthresh severity_threshold
Specifies the threshold on the severity of latency in terms of the throughput loss
on the port at the sub-second level. The severity threshold is a floating-point value
in the range of no less than 1 and no greater than 1000. This value specifies the
factor by which throughput must drop in a second in order for that second to be
considered affected by latency bottlenecking. For example, a value of 20 means
that the observed throughput in a second must be no more than 1/20th the
capacity of the port in order for that second to be counted as an affected second.
The default value is 50. This command erases the statistics history and restarts
alert calculations (if alerting is enabled) on the specified ports. When used with the
config option, you must specify a port.
84
Fabric OS Command Reference
53-1003108-01
bottleneckMon
2
--exclude [slot/]port_list
Excludes the specified ports from bottleneck detection. No data will be collected
from these ports, and no alerts will be triggered for these ports. All statistics
history for a port is erased when a port is excluded. Alerting parameters are
preserved. It is not recommended to exclude ports from monitoring except under
special circumstances, for example, when a long-distance port is known to be a
bottleneck because of credit insufficiency. The wildcard (*) port specifier is allowed
but not recommended. Use --disable to exclude all ports on the switch.
--include [slot/]port_list
Includes previously excluded ports for bottleneck detection. Previously configured
switch-wide alerts and threshold parameters reapply when bottleneck detection
resumes. The wildcard (*) port specifier may be used as a shorthand for removing
all exclusions.
--configclear [slot/]port_list
Removes any port-specific alert parameters from the specified ports and restores
switch-wide parameters on these ports. You can still view the history of
bottlenecks statistics on these ports. However, alert calculations restart on the
specified ports after the parameter reset. This operation is allowed on excluded
ports.
--disable
Disables bottleneck detection on the entire switch. This operation erases all
configuration details, including the list of excluded ports, all custom thresholds and
alerting parameters for specific ports, and all historical data.
--show [[slot/]port |*]
Displays a history of the bottleneck severity for the specified ports. The output
shows the percentage of one-second intervals affected by the bottleneck condition
within the specified time interval. When a single port is specified, the command
displays the bottleneck statistic for that port. When the wildcard (*) is specified, the
same statistic is displayed for every port on the switch. Additionally, a combined
"union" statistic for the switch as a whole is displayed. When used without a port
specifier, the command displays the number of ports affected by bottleneck
conditions. A "bottlenecked" port in this output is defined as any port that was
affected by a bottleneck for one second or more in the corresponding interval.
This command succeeds only on online ports.
The following operands are optional:
-interval seconds
Specifies the time window in seconds over which the percentage of seconds
affected by bottleneck conditions is displayed in the output. When a port is
specified with the --show command, the maximum interval is 10800 seconds (3
hours). When a wildcard (*) is specified, the maximum interval is defined such that
the value of -span divided by the value of the interval cannot exceed 30. The
interval value must be greater than 0.The default value is 10 seconds.
-span seconds
Specifies the total duration in seconds covered in the output. When a port is
specified with the --show command, the maximum span is 10800 seconds (3
hours). When a wildcard (*) is specified, the maximum span is defined such that
the value of -span divided by the value of the interval cannot exceed 30. The span
value must be greater than 0. The default value is 10 seconds.
History data are maintained for a maximum of three hours per port, so the span
can be 10800 seconds at most. When the show command is issued for all ports
(*), the maximum duration is defined such that the value of -span divided by the
value of the interval cannot exceed 30.
Fabric OS Command Reference
53-1003108-01
85
2
bottleneckMon
-refresh
Refreshes the display to continuously update with fresh data at a certain rate. The
refresh rate is equal to the number of seconds specified in the interval.
-congestion | -latency
Restricts the display to congestion or latency data. If neither is specified, the
command displays combined statistics for both types of bottlenecks.
--status
Displays the details of the Bottleneck Detection configuration for the current
(logical) switch. Refer to the command description section for an explanation of
the displays. If virtual fabrics are enabled, ports not belonging to the current
logical switch are not displayed.
--help
Displays the command usage.
Back-end port credit recovery commands
The following operands support backend port credit recovery:
--cfgcredittools -intport -recover
Configures credit recovery for backend ports. Use one of the following required
recovery options to configure credit recovery:
-recover onLrOnly
Enables the backend port recovery feature in link reset mode.
-recover onLrThresh
Enables the backend port recovery feature in link reset threshold mode.
-recover off
Disables the backend port credit recovery feature.
-lrthresh threshold
Specifies the link reset threshold value. Note that the threshold value set using
this option will apply only when the recovery mode is onLrThresh.
-fault edgeblade
In this mode, the edge blade alone is faulted when the link reset threshold is
reached.
-fault coreblade
In this mode, the core blade alone is faulted when the link reset threshold is
reached.
-fault edgecoreblade
In this mode, the edge blade is faulted the first two times the link reset threshold
value is reached. If the threshold value is reached the third time, the core blade is
faulted.
The -fault option is supported only with the onLrThresh option.
--cfgcredittools -intport -check
Performs the on-demand detection of credit loss on a given backend port and VC.
This operand is optional and exclusive; when you specify this option you cannot
use the --cfgcredittools -intport -recover options at the same time. You must
specify a port and a VC, separated by a comma. A space before the comma is not
permitted.
slot/blade_port
Specifies the backend port that is to be examined for credit loss. The port number
must be the blade port number, since this is a backend port. The blade port
number can be located in the "Bpt" column output of the bladePortMap
command. Note that the bladeportmap command requires root permissions.
86
Fabric OS Command Reference
53-1003108-01
bottleneckMon
2
VC
Specifies the Virtual Channel number. The valid range is 1 trough 31. VC 0 is
invalid.
--linkreset slot/blade_port
Performs a link reset on the specified front-end or back-end blade port. The blade
port number can be located in the "Bpt" column output of the bladePortMap
command. The bladeportmap command requires root permissions.
--showcredittools
Displays the backend port credit recovery configuration as enabled or disabled. In
addition, the output indicates whether link reset mode or link reset threshold mode
is configured.
--help
Displays the command usage.
EXAMPLES
Bottleneck detection examples
To enable bottleneck detection on the switch without alerts (statistics collected with default parameters
are still available for viewing):
switch:admin> bottleneckmon --enable
To enable bottleneck detection on the switch with congestion and latency alerts using default values for
thresholds and time (preferred use case):
switch:admin> bottleneckmon --enable -alert
To enable bottleneck detection on the switch with congestion alerts only:
switch:admin> bottleneckmon --enable -alert=congestion
To enable bottleneck detection on the switch with latency alerts only:
switch:admin> bottleneckmon --enable -alert=latency
To customize congestion bottleneck detection on a port range after default alerts are enabled
switch-wide:
switch:admin> bottleneckmon --enable -alert
switch:admin> bottleneckmon --config -alert
-cthresh .5 -time 240 1-15
\
To change the bottleneck detection configuration on the logical switch to allow congestion alerts only:
switch:admin> bottleneckmon --config -alert=congestion
To change the bottleneck detection configuration on the logical switch to allow latency alerts only:
switch:admin> bottleneckmon --config -alert=latency
To change the bottleneck detection configuration on the logical switch to allow both congestion and
latency alerts:
switch:admin> bottleneckmon --config -alert
To change the bottleneck detection configuration on the logical switch to disable all alerts:
switch:admin> bottleneckmon --config -noalert
Fabric OS Command Reference
53-1003108-01
87
2
bottleneckMon
To change the bottleneck detection configuration on port 5 to allow congestion alerts only; overrides
switch-wide configuration:
switch:admin> bottleneckmon --config -alert=congestion 5
To change the bottleneck detection configuration on port 5 to allow latency alerts only; overrides
switch-wide configuration:
switch:admin> bottleneckmon --config -alert=latency 5
To change the bottleneck detection configuration on port 5 to allow congestion and latency alerts;
overrides switch-wide configuration:
switch:admin> bottleneckmon --config -alert 5
To change the bottleneck detection configuration on port 5 to disable alerts; overrides switch-wide
configuration:
switch:admin> bottleneckmon --config -noalert 5
To disable bottleneck detection on a specified port:
switch:admin> bottleneckmon --exclude 2/4
To disable bottleneck detection on all ports of a chassis:
switch:admin> bottleneckmon --disable
To display the number of ports affected by bottleneck conditions:
switch:admin> bottleneckmon --show
======================================================
Fri Feb 26 22:00:00 UTC 2010
======================================================
List of bottlenecked ports in most recent interval:
13 16
=======================================================
Number of
From
To
bottlenecked ports
=======================================================
Feb 26 21:59:50
Feb 26 22:00:00
2
Feb 26 21:59:40
Feb 26 21:59:50
0
Feb 26 21:59:30
Feb 26 21:59:40
0
Feb 26 21:59:20
Feb 26 21:59:30
0
Feb 26 21:59:10
Feb 26 21:59:20
0
Feb 26 21:59:00
Feb 26 21:59:10
0
Feb 26 21:58:50
Feb 26 21:59:00
0
Feb 26 21:58:40
Feb 26 21:58:50
0
Feb 26 21:58:30
Feb 26 21:58:40
0
Feb 26 21:58:20
Feb 26 21:58:30
2
Feb 26 21:58:10
Feb 26 21:58:20
3
Feb 26 21:58:00
Feb 26 21:58:10
3
Feb 26 21:57:50
Feb 26 21:58:00
3
Feb 26 21:57:40
Feb 26 21:57:50
3
Feb 26 21:57:30
Feb 26 21:57:40
2
Feb 26 21:57:20
Feb 26 21:57:30
2
Feb 26 21:57:10
Feb 26 21:57:20
0
Feb 26 21:57:00
Feb 26 21:57:10
0
Feb 26 21:56:50
Feb 26 21:57:00
0
Feb 26 21:56:40
Feb 26 21:56:50
0
Feb 26 21:56:30
Feb 26 21:56:40
0
Feb 26 21:56:20
Feb 26 21:56:30
0
88
Fabric OS Command Reference
53-1003108-01
bottleneckMon
Feb
Feb
Feb
Feb
Feb
26
26
26
26
26
21:56:10
21:56:00
21:55:50
21:55:40
21:55:30
Feb
Feb
Feb
Feb
Feb
26
26
26
26
26
21:56:20
21:56:10
21:56:00
21:55:50
21:55:40
2
0
0
0
0
0
To display bottleneck statistics for a single port:
switch:admin> bottleneckmon --show \
-interval 5 -span 30 2/4
=============================================
Wed Jan 13 18:54:35 UTC 2010
=============================================
Percentage of
From
To
affected secs
==============================================
Jan 13 18:54:05
Jan 13 18:54:10
20.00%
Jan 13 18:54:10
Jan 13 18:54:15
60.00%
Jan 13 18:54:15
Jan 13 18:54:20
0.00%
Jan 13 18:54:20
Jan 13 18:54:25
0.00%
Jan 13 18:54:25
Jan 13 18:54:30
40.00%
Jan 13 18:54:30
Jan 13 18:54:35
80.00%
To display the bottleneck statistic for every port in the switch including the union of all individual port
statistics:
switch:admin> bottleneckmon --show -interval 5 -span 30 *
=============================================================
Wed Jan 13 18:54:35 UTC 2010
=============================================================
=================================================================
From
To
0
1
2
3
4
5
=================================================================
Jan13 18:54:05 Jan13 18:54:10 20.00 20.00 0.00 80.00 20.00 100.00
=================================================================
From
To
5
6
7
8
UNION
=================================================================
Jan13 18:54:05 Jan13 18:54:10 40.00 0.00 0.00 20.00 100.00
=================================================================
From
To
0
1
2
3
4
5
=================================================================
Jan13 18:54:10 Jan13 18:54:15 0.00 0.00 20.00 40.00 20.00 0.00
=================================================================
From
To
5
6
7
8
UNION
=================================================================
Jan13 18:54:10 Jan13 18:54:15 0.00 20.00 0.00
0.00 40.00
To display only the union statistic for the switch:
switch:admin> bottleneckmon --show -interval 5 -span 30
=============================================================
Wed Jan 13 18:54:35 UTC 2010
=============================================================
Percentage of
From
To
affected secs
=============================================================
Jan 13 18:54:05
Jan 13 18:54:10
80.00
Fabric OS Command Reference
53-1003108-01
89
2
bottleneckMon
Jan
Jan
Jan
Jan
Jan
13
13
13
13
13
18:54:10
18:54:15
18:54:20
18:54:25
18:54:30
Jan
Jan
Jan
Jan
Jan
13
13
13
13
13
18:54:15
18:54:20
18:54:25
18:54:30
18:54:35
20.00
80.00
0.00
0.00
40.00
To display bottleneck configuration details for the switch:
switch:admin> bottleneckmon --status
Bottleneck detection - Enabled
==============================
Switch-wide sub-second latency bottleneck criterion:
====================================================
Time threshold
- 0.800
Severity threshold
- 50.000
Switch-wide alerting parameters:
=================================
Alerts
- Congestion only
Congestion threshold for alert - 0.800
Averaging time for alert
- 300 seconds
Quiet time for alert
- 300 seconds
Per-port overrides for sub-second latency bottleneck criterion:
===============================================================
Slot
Port
TimeThresh
SevThresh
=========================================
1
3
0.500
100.000
1
4
0.600
50.000
1
5
0.700
20.000
Per-port overrides for alert parameters:
========================================
Slot Port Alerts? LatencyThresh CongestionThresh Time(s) QTime(s)
=================================================================
1
1
Y
0.100
0.800
300
300
1
2
C
-0.800
600
600
1
3
L
0.100
-300
300
1
4
N
----Excluded ports:
===============
Slot
Port
============
1
2
1
3
1
4
Backend port credit recovery examples
To enable backend port credit recovery with the link reset only option and to display the configuration:
switch:admin> bottleneckmon --cfgcredittools \
-intport -recover onLrOnly
switch:admin> bottleneckmon --showcredittools
Internal port credit recovery is Enabled with LrOnly
90
Fabric OS Command Reference
53-1003108-01
bottleneckMon
2
To enable backend port credit recovery with the link reset threshold option and to display the
configuration:
switch:admin> bottleneckmon --cfgcredittools -intport \
-recover onLrThresh
switch:admin> bottleneckmon --showcredittools
Internal port credit recovery is Enabled with LrOnThresh
To disable backend port credit recovery and to display the configuration:
switch:admin> bottleneckmon --cfgcredittools \
-intport -recover off
switch:admin> bottleneckmon --showcredittools
Internal port credit recovery is Disabled
To examine a backend port for credit loss:
switch:admin> bottleneckmon --cfgcredittools \
-intport -recover off
switch:admin> bottleneckmon --cfgcredittools -intport -check 10/4,30
Started Credit loss Detection on slot 10 port 4 VC 30.
Please wait....
Detected credit loss.
Link Reset performed.
SEE ALSO
creditRecovMode
Fabric OS Command Reference
53-1003108-01
91
2
bpPortLoopbackTest
bpPortLoopbackTest
Sends and receives data from the same BP port to perform a functional test of the port.
SYNOPSIS
DESCRIPTION
bpportloopbacktest [--slot slot]
[-nframes count]
[-pklen count]
[-lb_mode mode]
[-spd_mode mode ]
[-bpports itemlist ]
Use this command to verify the functional operation of the switch. The test sends frames from a specified
blade processor (BP) port transmitter and loops the frames back into the same BP port's receiver. The
path exercised in this test includes the connections from the BP chip to the Control Processor (CP) chip.
The test can be performed on a single port or on a range of BP ports.
Before running this diagnostic, you must disable the chassis and clear all logs using the following
command sequence:
1.
Execute chassisDisable
2.
Execute slotStatsClear
3.
Execute diagClearError -all
4.
Execute cryptoCfg --disableEE (if the encryption engine is in enabled state)
By default, eight frames are transmitted and received on each port. The test method is as follows:
92
1.
Set all ports present for the loopback mode specified.
2.
Create a frame F of maximum data size (2112 bytes).
3.
Transmit frame F through the specified port.
4.
Pick up the frame from the same port.
5.
Check if any of the following statistic error counters report nonzero values: ENC_in, CRC_err,
TruncFrm, FrmTooLong, BadEOF, Enc_out, BadOrdSet, DiscC3.
6.
Check if the transmit, receive, or class 3 receiver counters are stuck at some value.
7.
Check if the number of frames transmitted is not equal to the number of frames received.
8.
Repeat steps two through seven for all specified ports until one of the following conditions is met:
a.
The number of frames (or nframes) requested is reached.
b.
All ports are marked bad.
Fabric OS Command Reference
53-1003108-01
bpPortLoopbackTest
2
At each pass, a different data type is used to create the frame from a palette of seven. If a pass of seven
is requested, seven different frames are used in the test. If eight passes, the first seven frames are
unique, and the eighth frame is the same as the first. The data palette of seven consists of the following
data types:
1)
2)
3)
4)
5)
6)
7)
NOTES
CSPAT: 0x7e, 0x7e, 0x7e, 0x7e, ...
BYTE_LFSR: 0x69, 0x01, 0x02, 0x05, ...
CHALF_SQ: 0x4a, 0x4a, 0x4a, 0x4a, ...
QUAD_NOT: 0x00, 0xff, 0x00, 0xff, ...
CQTR_SQ: 0x78, 0x78, 0x78, 0x78, ...
CRPAT: 0xbc, 0xbc, 0x23, 0x47, ...
RANDOM: 0x25, 0x7f, 0x6e, 0x9a, ...
This command does not support High Availability (HA).
This command is currently supported only on the Brocade Encryption platform at a default speed of 4
Gbps and a loopback mode of 7. Use portLoopBackTest on all other platforms.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--slot slot
Specifies the slot number on bladed systems.
-nframes count
Specifies the number of frames to send. The test progresses until the specified
number of frames has been transmitted on each port. The default value is 8.
-pklen count
Specifies the size of the packet to be sent. The default is 2112 bytes. The valid
range is 100 to 2112 bytes.
-lb_mode mode
Specifies the loopback point for the test. The Brocade Encryption Platform, only
supports line loopback (lb_mode 7) and lb_mode defaults to 7 when the
parameter is not specified. Mode values are as follows:
1
Port Loopback (loopback plugs)
2
External (SERDES) loopback
7
Back-end bypass & port loopback
8
Back-end bypass & SERDES loopback
-spd_mode mode
Specifies the speed mode for the test. On the Brocade Encryption platforms only a
speed of 4 Gbps is supported and spd_mode defaults to 4 when the parameter is
not specified.
1
Runs test at 1 Gbps (deprecated).
2
Runs test at 2 Gbps.
4
Runs test at 4 Gbps (Default for Encryption platforms).
Fabric OS Command Reference
53-1003108-01
93
2
bpPortLoopbackTest
8
Runs test at 8 Gbps (Default for Condor2).
16
Runs test at 16 Gbps (Condor3 only).
-bpports itemlist
Specifies a list of blade ports to test. By default all valid blade ports in the specified
blade are tested. On the Brocade Encryption platforms, ports 80-103 are the only
valid ports, because these are the only blade ports with access to the Vader chip.
Refer to the itemList help page for further information on the itemlist parameter.
DIAGNOSTICS
When it detects failures, the test may report one or more of the following error messages. If errors
persist, contact Technical Support.
DATA
Data received does not match the data sent.
ERRSTAT
Errors were found in the ASIC statistics.
INIT
Port failed to initialize.
PORTDIED
A previously initialized port went to an un-initialized state.
STATS
Errors were found in the ASIC statistics.
TIMEOUT
Did not receive a frame in the given timeout period.
XMIT
Frame transmission failure.
EXAMPLES
To run the test on blade ports 80-90 with one frame:
switch:admin> bpportloopbacktest -bpports 80-90 -nframes 1
Running bpportloopbacktest ..............
Ram Init
Ob1 portloopbacktest on ports 80-90 lbMode 7 speed 4
Info: Vader port 0 recovering Rx Fifo
Info: Vader port 1 recovering Rx Fifo
Info: Vader port 2 recovering Rx Fifo
Info: Vader port 3 recovering Rx Fifo
Info: Vader port 4 recovering Rx Fifo
Info: Vader port 5 recovering Rx Fifo
Ob1 portloopbacktest on ports 80-90 PASSED
Test Complete: bpportloopbacktest Pass 1 of 1
Duration 0 hr, 0 min & 24 sec (0:0:24:599).
Cleaning up after test.......
passed.
SEE ALSO
94
itemList, portLoopbackTest
Fabric OS Command Reference
53-1003108-01
bpTurboRamTest
2
bpTurboRamTest
MBIST test for AP Blade BP ASICs.
SYNOPSIS
DESCRIPTION
bpturboramtest [--slot slot]
[ -passcnt count ]
[ -bpports itemlist ]
Use this command to verify the on-chip static random access memory (SRAM) located in the Blade
Processor (BP) ASICs of the Application Processor (AP) blade. The command makes use of the memory
built-in self-test (MBIST) circuitry.
Before running this diagnostics, you must disable the chassis and clear all logs using the following
command sequence:
1.
Execute chassisdisable
2.
Execute slotstatsclear
3.
Execute diagclearerror -all
4.
Execute cryptocfg --disableEE (if the encryption engine is in enabled state)
The test flow for each SRAM is as follows:
NOTES
1.
Fill RAM with alternating FFFF 0000 pattern. (Subtest 1: turboram memory fill)
2.
For each incrementing address read FFFF 0000 pattern and write 0000 FFFF. (Subtest 2: turboram
r-m-w inc 1)
3.
For each incrementing address read 0000 FFFF pattern and write FFFF 0000. (Subtest 3: turboram
r-m-w inc 2)
4.
For each decrementing address read FFFF 0000 pattern and write 0000 FFFF. (Subtest 4: turboram
r-m-w dec 1)
5.
For each decrementing address read 0000 FFFF pattern and write FFFF 0000. (Subtest 5: turboram
r-m-w dec 2)
6.
Repeat steps 1-5 with AAAA 5555 pattern.
This command is supported only on the Brocade Encryption Switch. It complements the
bpTurboramTest, which tests the Condor2 ASIC on the switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--slot slot
Specifies the slot number on bladed systems.
-passcnt count
Specifies the number of test repetitions. By default the test runs once.
-bpports itemlist
Specifies a list of blade ports to test. By default all blade ports in the specified
blade are tested. Note that on the Encryption platform, ports 80-103 are the blade
ports connected to the BP ASICs. Refer to the itemList help page for further
information on the itemlist parameter.
Fabric OS Command Reference
53-1003108-01
95
2
bpTurboRamTest
EXAMPLES
To run the test in default mode:
switch:admin> bpturboramtest
Running bpturboramtest ..............
Board Init
Running Vader bist test
Vader bist test PASSED
Running Ob1 bist test
Ob1 bist test PASSED
BIST test PASSED on all ASIC(s)
Test Complete: bpturboramtest Pass 1 of 1
Duration 0 hr, 1 min & 55 sec (0:1:55:884).
Cleaning up after test.......
passed.
SEE ALSO
96
turboRamTest
Fabric OS Command Reference
53-1003108-01
bufOpMode
2
bufOpMode
Changes or displays the Buffer Optimized Mode.
SYNOPSIS
bufopmode --set slot [-f]
bufopmode --reset slot
bufopmode --show slot
bufopmode --showall
DESCRIPTION
Use this command to display or change the buffer optimized mode on a switch.
When buffer optimized mode is enabled on a slot, additional buffers are allocated on the internal ports.
Use this feature, if you have slow draining devices connected to the slot and there are no long distance
links or F_Port buffers configured on that slot.
You must power off the slot before changing the buffer optimized mode. Changes take effect immediately
after the slot is powered on
Enabling buffer optimized mode removes all long distance configurations or F_Port buffers on that slot.
You will be prompted if any F_Port buffers or long distance configurations are detected.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command is supported only on the Brocade FC8-16, FC8-32, and FC8-48 blades in a DCX or
DCX-4S chassis. An asterisk (*) next to the slot configuration status indicates an unsupported blade.
Refer to the example section for an illustration.
This command is not supported on Control Processor (CP) blades and core blades.
OPERANDS
This command has the following operands:
slot
Specifies the slot number.
--set
Enables buffer optimized mode on the specified slot. This commands prompts for
confirmation before removing any F_Port buffers or long distance configurations
on that slot. Use the -f option to execute this command without confirmation.
--reset
Clears buffer optimized mode on the specified slot.
--show
Displays the current buffer optimized mode for the specified slot (On or Off).
--showall
Displays the current buffer optimized mode for all slots. An asterisk (*) next to the
slot configuration status indicates an unsupported blade.
EXAMPLES
To display the buffer optimized mode for all slots on a DCX with supported blades:
switch:admin> bufopmode --showall
Slot 1: buffer optimized mode - Off
Slot 2: buffer optimized mode - Off
Slot 3: buffer optimized mode - Off
Slot 4: buffer optimized mode - Off
Fabric OS Command Reference
53-1003108-01
97
2
bufOpMode
Slot 9: buffer optimized mode - Off
Slot 10: buffer optimized mode - Off
Slot 11: buffer optimized mode - Off
Slot 12: buffer optimized mode - On
-------------------------------------------------* indicates buffer optimization not supported on this blade
To display current buffer optimized mode for a single slot
switch:admin> bufopmode --show 12
Slot 12: buffer optimized mode - On
To enable buffer optimized mode for a given slot:
switch:admin> bufopmode --set 11
The slot must first be powered off to perform this operation
switch:admin> bufopmode --reset 12
The slot must first be powered off to perform this operation
switch:admin> slotpoweroff 11
switch:admin> slotpoweroff 12
switch:admin> bufopmode --set 12
Buffer optimized mode is turned on for slot 11
switch:admin> bufopmode --reset 12
Buffer optimized mode is turned off for slot 12
switch:admin> slotpoweron 11
switch:admin> slotpoweron 12
To display the changes:
switch:admin> bufopmode --showall
Slot 1: buffer optimized mode - Off
Slot 2: buffer optimized mode - Off
Slot 3: buffer optimized mode - Off
Slot 4: buffer optimized mode - On
Slot 9: buffer optimized mode - Off
Slot 10: buffer optimized mode - Off
Slot 11: buffer optimized mode - On
Slot 12: buffer optimized mode - Off
----------------------------------------------------------* indicates buffer optimization not supported on this blade
To display the buffer optimized mode for all slots on a DCX 8510-8 with unsupported 16G port blades:
switch:admin> bufopmode --showall
Slot
Slot
Slot
Slot
Slot
Slot
98
1: buffer optimized mode - Off*
2: buffer optimized mode - Off*
3: buffer optimized mode - Off*
4: buffer optimized mode - Off*
9: buffer optimized mode - Off*
10: buffer optimized mode - Off*
Fabric OS Command Reference
53-1003108-01
bufOpMode
2
Slot 11: buffer optimized mode - Off*
Slot 12: buffer optimized mode - Off*
----------------------------------------------------------* indicates buffer optimization not supported on this blade
SEE ALSO
slotShow, slotPowerOn, slotPowerOff
Fabric OS Command Reference
53-1003108-01
99
2
ceePortLedTest
ceePortLedTest
DESCRIPTION
SEE ALSO
100
See portLedTest.
None
Fabric OS Command Reference
53-1003108-01
ceePortLoopbackTest
2
ceePortLoopbackTest
DESCRIPTION
SEE ALSO
See portLoopbackTest.
None
Fabric OS Command Reference
53-1003108-01
101
2
ceeTurboRamTest
ceeTurboRamTest
DESCRIPTION
SEE ALSO
102
See turboRamTest.
None
Fabric OS Command Reference
53-1003108-01
cfgActvShow
2
cfgActvShow
Displays effective zone configuration information.
SYNOPSIS
DESCRIPTION
cfgactvshow
Use this command to display the effective zone configuration information.
The current configuration is a single zone configuration that is currently in effect. The devices that an
initiator sees are based on this configuration. The effective configuration is built when a specified zone
configuration is enabled.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the effective zone configuration information:
switch:admin> cfgactvshow
Effective configuration:
cfg:
c4
zone: z3
33:07:06:05:04:03:02:01
zone: z4
44:01:23:45:67:89:a0:bc
40:01:23:45:67:89:a0:bc
SEE ALSO
cfgClear, cfgDelete, cfgRemove, cfgSave, cfgShow
Fabric OS Command Reference
53-1003108-01
103
2
cfgAdd
cfgAdd
Adds a member to a zone configuration.
SYNOPSIS
DESCRIPTION
cfgadd "cfgName", "member[; member...]"
Use this command to add one or more members to an existing zone configuration.
This command changes the Defined Configuration. For the change to take effect, enable the
configuration with the cfgEnable command. For the change to be preserved across switch reboots, save
the configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operands are required:
"cfgName"
Specify a name for the zone configuration, enclosed in double quotation marks.
"member"
Specify a zone member or a list of zone members to be added to the
configuration. The list must be enclosed in double quotation marks. Members
must be separated by semicolons.
EXAMPLES
To add two new zones to the configuration "Test_cfg":
switch:admin> cfgadd "Test_cfg", "greenzone;bluezone"
SEE ALSO
104
cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgSave, cfgShow
Fabric OS Command Reference
53-1003108-01
cfgClear
2
cfgClear
Clears all zone configurations.
SYNOPSIS
DESCRIPTION
cfgclear
Use this command to clear all zone information in the transaction buffer. All defined zone objects in the
transaction buffer are deleted. If an attempt is made to commit the empty transaction buffer while a zone
configuration is enabled, you are warned to first disable the enabled zone configuration or to provide a
valid configuration with the same name.
After clearing the transaction buffer with the cfgClear command, use the cfgDisable command to clear
the entire zoning configuration (both the transaction buffer and the active configuration). If there is no
current active zoning configuration, or you just want to clear the transaction buffer, use the cfgSave
command to commit the transaction.
If the default zone access mode is "No Access", this command recreates the default zoning objects.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
None
EXAMPLES
To clear all zones and then clear nonvolatile memory:
switch:admin> cfgclear
The Clear All action will clear all Aliases, Zones, FA Zones
and configurations in the Defined configuration.
Run cfgSave to commit the transaction or cfgTransAbort to
cancel the transaction.
Do you really want to clear all configurations? \
(yes, y, no, n): [no] n
switch:admin> cfgsave
You are about to save the Defined zoning configuration. This
action will only save the changes on Defined configuration.
Any changes made on the Effective configuration will not
take effect until it is re-enabled. Until the Effective
configuration is re-enabled, merging new switches into the
fabric is not recommended and may cause unpredictable
results with the potential of mismatched Effective Zoning
configurations.
Do you want to save Defined zoning configuration only? \
(yes, y, no, n): [no]n
SEE ALSO
cfgDisable, cfgEnable, cfgSave
Fabric OS Command Reference
53-1003108-01
105
2
cfgCreate
cfgCreate
Creates a zone configuration.
SYNOPSIS
DESCRIPTION
cfgcreate "cfgName", "member[;member...]"
Use this command to create a new zone configuration.
This command changes the Defined Configuration (see cfgShow). For the change to become effective,
enable the configuration with the cfgEnable command. For the change to be preserved across switch
reboots, save the configuration to nonvolatile memory with the cfgSave command.
Refer to the zoneCreate command for more information on name and member specifications.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operands are required:
"cfgName"
Specify a name for the zone configuration in double quotation marks. A zone
configuration name must begin with a letter followed by any number of letters,
numbers, and underscores. Names are case-sensitive. For example, "Cfg_1" and
"cfg_1" are different zone configurations. Blank spaces are ignored.
"member"
Specify a zone member or list of zone members to be added to the configuration.
The list must be enclosed in double quotation marks. Members must be separated
by semicolons. The zone configuration member list must have at least one
member. Empty member lists are not allowed.
EXAMPLES
To create a configuration containing three zones:
switch:admin> cfgcreate "USA_cfg",
"Purple_zone;Blue_zone;Green_zone"
SEE ALSO
106
\
cfgAdd, cfgClear, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgSave, cfgShow
Fabric OS Command Reference
53-1003108-01
cfgDelete
2
cfgDelete
Deletes a zone configuration.
SYNOPSIS
DESCRIPTION
cfgdelete "cfgName"
Use this command to delete a zone configuration.
This command changes the Defined Configuration (see cfgShow). For the change to become effective,
enable the configuration with the cfgEnable command. For the change to be preserved across switch
reboots, save the configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operand is required:
"cfgName"
Specify a name for the zone configuration to be deleted. The name must be
enclosed in double quotation marks.
EXAMPLES
To delete a zone configuration:
switch:admin> cfgdelete "USA_cfg"
SEE ALSO
cfgAdd, cfgClear, cfgCreate, cfgDisable, cfgEnable, cfgRemove, cfgSave, cfgShow
Fabric OS Command Reference
53-1003108-01
107
2
cfgDisable
cfgDisable
Disables a zone configuration.
SYNOPSIS
DESCRIPTION
cfgdisable
Use this command to disable the current zone configuration. The fabric returns to non-zoning mode, a
mode in which all devices can see each other.
This command ends and commits the current zoning transaction buffer to both volatile and nonvolatile
memory. If a transaction is open on a different switch in the fabric when this command is run, the
transaction on the other switch is automatically aborted. A message displays on the other switches to
indicate that the transaction was aborted.
If the default zone access mode is "No Access", then this command becomes equivalent to cfgEnable
"d_efault_Cfg". Refer to defZone help for information on zone access configuration.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
None
EXAMPLES
To disable the current zone configuration:
switch:admin> cfgdisable
You are about to disable zoning configuration. This
action will disable any previous zoning configuration.
Do you want to disable zoning configuration? \
(yes, y, no, n): [no] y
SEE ALSO
108
cfgClear, cfgEnable, cfgSave
Fabric OS Command Reference
53-1003108-01
cfgEnable
2
cfgEnable
Enables a zone configuration.
SYNOPSIS
DESCRIPTION
cfgenable "cfgName"
Use this command to enable a zone configuration. The command builds the specified zone configuration.
It checks for undefined zone names, zone alias names, or other inconsistencies, by expanding zone
aliases, removing duplicate entries, and then installing the effective configuration.
If the build fails, the previous state is preserved (zoning remains disabled, or the previous effective
configuration remains in effect). If the build succeeds, the new configuration replaces the previous
configuration. Refer to the cfgShow command for a description of the defined and effective
configurations.
If there are open transactions in the fabric, only single transaction can be saved. Use the cfgtransshow
--opentrans command to view the list of all the domains in the fabric with open transactions.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operand is required:
"cfgName"
Specifies the name of the zone configuration. The name must be enclosed in
double quotation marks.
EXAMPLES
To enable the zone configuration USA_cfg:
switch:admin> cfgenable "USA_cfg"
You are about to enable a new zoning configuration.
This action will replace the old zoning configuration with the
current configuration selected. If the update includes changes
to one or more traffic isolation zones, the update may result in
localized disruption to traffic on ports associated with
the traffic isolation zone changes
Do you want to enable 'USA_cfg' configuration \
(yes, y, no, n): [no] y
zone config "USA_cfg" is in effect
Updating flash ...
To enable the zone configuration USA_cfg when there are open transactions in the fabric:
switch:admin> cfgenable "USA_cfg"
You are about to enable a new zoning configuration.
This action will replace the old zoning configuration with the
current configuration selected. If the update includes changes
to one or more traffic isolation zones, the update may result in
localized disruption to traffic on ports associated with
the traffic isolation zone changes
Multiple open transactions are pending in this fabric. Only one
transaction can be saved.Please abort all unwanted transactions
using the cfgtransabort command. Use the cfgtransshow --opentrans
command to display a list of domains with open transactions
Fabric OS Command Reference
53-1003108-01
109
2
cfgEnable
switch:admin> cfgtransabort 271010736
switch:admin> cfgenable "USA_cfg"
You are about to enable a new zoning configuration.
This action will replace the old zoning configuration with the
current configuration selected. If the update includes changes
to one or more traffic isolation zones, the update may result in
localized disruption to traffic on ports associated with
the traffic isolation zone changes
Do you want to enable 'USA_cfg' configuration \
(yes, y, no, n): [no] y
zone config "USA_cfg" is in effect
Updating flash ...
SEE ALSO
110
cfgClear, cfgDisable, cfgSave, cfgShow
Fabric OS Command Reference
53-1003108-01
cfgRemove
2
cfgRemove
Removes a member from a zone configuration.
SYNOPSIS
DESCRIPTION
cfgremove "cfgName","member[; member...]"
Use this command to remove one or more members from an existing zone configuration. If all members
are removed, the zone configuration is deleted.
This command changes the Defined Configuration (see cfgShow). For the change to become effective,
enable the configuration with the cfgEnable command. For the change to be preserved across switch
reboots, save the configuration to nonvolatile memory with the cfgSave command.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
The following operands are required:
"cfgName"
Specify a name for the zone configuration, enclosed in double quotation marks.
"member"
Specify a zone member or a list of zone members to be removed from the
configuration. The list must be enclosed in double quotation marks. Members
must be separated by semicolons.
EXAMPLES
To remove a zone from a configuration:
switch:admin> cfgremove "Test_cfg", "bluezone"
SEE ALSO
cfgAdd, cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgSave, cfgShow, cfgTransAbort,
cfgTransShow
Fabric OS Command Reference
53-1003108-01
111
2
cfgSave
cfgSave
Saves the zone configuration to nonvolatile memory.
SYNOPSIS
DESCRIPTION
cfgsave
Use this command to save the current zone configuration. This command writes the defined
configuration and the name of the effective configuration to nonvolatile memory in all switches in the
fabric.
The saved configuration is automatically reloaded at power on, and, if a configuration was in effect at the
time it was saved, the same configuration is reinstalled with an automatic cfgEnable command.
Because the saved configuration is reloaded at power on, only valid configurations are saved. The
cfgSave command validates the effective configuration by performing the same tests as the cfgEnable
command. If the tests fail, an error message is displayed and the configuration is not saved.
This command ends and commits the current transaction. If a transaction is open on a different switch in
the fabric when this command is run, the transaction on the other switch is automatically aborted. A
message displays on the other switches to indicate that the transaction was aborted.
If there are open transactions in the fabric, only single transaction can be saved. Use the cfgtransshow
--opentrans command to view the list of all the domains in the fabric with open transactions.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
None
EXAMPLES
To save a zone configuration:
switch:admin> cfgsave
WARNING!!!
The changes you are attempting to save will render the
Effective configuration and the Defined configuration
inconsistent. The inconsistency will result in different
Effective Zoning configurations for switches in the fabric if
a zone merge or HA failover happens. To avoid inconsistency
it is recommended to commit the configurations using the
cfgenable command.
Do you want to save Defined zoning configuration
only? (yes, y, no, n): [no]y
To save a zone configuration if there are multiple open transactions:
switch:admin> cfgsave
You are about to save the Defined zoning configuration. This
action will only save the changes on Defined configuration.
Multiple open transactions are pending in this fabric. Only one
transaction can be saved.Please abort all unwanted transactions
using the cfgtransabort command. Use the cfgtransshow --opentrans
command to display a list of domains with open transactions
Do you want to save the Defined zoning configuration only? (yes, y, no, n):
[no] n
switch:admin> cfgtransabort 271010736
112
Fabric OS Command Reference
53-1003108-01
cfgSave
2
switch:admin> cfgsave
You are about to save the Defined zoning configuration. This
action will only save the changes on Defined configuration.
Do you want to save the Defined zoning configuration only? (yes, y, no, n):
[no] y
SEE ALSO
cfgAdd, cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgShow,
cfgTransAbort, cfgTransShow
Fabric OS Command Reference
53-1003108-01
113
2
cfgShow
cfgShow
Displays zone configuration information.
SYNOPSIS
cfgshow [--ic] ["pattern"] [, mode]
cfgshow [--transdiffs]
cfgshow [--transdiffsonly]
cfgshow --help
DESCRIPTION
Use this command to display zone configuration information.
If no operand is specified, all zone configuration information (both defined and effective) is displayed. If
the local switch has an outstanding transaction, this command displays the most recently edited zone
configuration that has not yet been saved. If the local switch has no outstanding transaction, this
command displays the committed zone configuration.
If a pattern is specified, only matching configurations are displayed.
•
The defined configuration is the complete set of all zone objects that have been defined in the
fabric. There can be multiple zone configurations defined, but only one can be enabled at a time.
There might be inconsistencies in the definitions, zones, or aliases that are referenced but not
defined, or there might be duplicate members. The defined configuration is the current state of the
administrator input.
•
The effective configuration is the single zone configuration that is currently enabled. The devices
that an initiator sees in the fabric are based on this configuration. The effective configuration is built
when a specific zone configuration is enabled and all error checking has been completed
successfully.
Use the --transdiffs and --transdiffsonly options to view changes in the current transaction.
The command output displays changes in the current transaction by the following notations:
•
An asterisk(*) before any tag indicates a change in that zone, zone configuration, alias or any other
entity in the zone configuration.
•
•
A plus(+) before any entity indicates that it is a newly added entity.
A minus(-) before any entity indicates that it is a deleted entity.
When this command is executed after a zoning transaction was aborted on the local switch, it displays
the following warning message: "Warning: Current Zoning Transaction was aborted. Reason code =
Zone Config update received."
When default zoning is enabled with "No Access" mode, "No Effective configuration: (No Access)" is
displayed.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The following operands are optional:
--ic
Displays all zone configuration names for a given pattern without case distinction.
114
Fabric OS Command Reference
53-1003108-01
cfgShow
2
"pattern"
A regular expression that matches zone configuration names. The pattern must
be enclosed in quotation marks and can contain the following:
Question mark (?)
Matches any single character
Asterisk (*)
Matches any string of characters.
Range
Matches any character within the range. Ranges must be enclosed in square
brackets, for example, [0-9] or [a-f].
mode
Specify 0 to display the contents of the transaction buffer (the contents of the
current transaction) or specify 1 to display the contents of nonvolatile memory.
The default value is 0.
--transdiffs
Displays changes in the current transaction.
--transdiffsonly
Displays only the changes in the current transaction.
EXAMPLES
To display all zone configurations that start with "Test":
switch:admin> cfgshow "Test*"
cfg:
Test1 Blue_zone
cfg:
Test_cfg Red_zone; Blue_zone
To display all zone configurations that start with "Test", regardless of the case:
switch:admin> cfgshow -ic "Test*"
cfg:
Test1 Blue_zone
cfg:
TEST2_cfg Red_zone; Blue_zone
To display all zone configuration information:
switch:admin> cfgshow
Defined configuration:
cfg:
USA1
Blue_zone
cfg:
USA_cfg Red_zone; Blue_zone
zone: Blue_zone
1,1; array1; 1,2; array2
zone: Red_zone
1,0; loop1
alias: array1 21:00:00:20:37:0c:76:8c; \
21:00:00:20:37:0c:71:02
alias: array2 21:00:00:20:37:0c:76:22; \
21:00:00:20:37:0c:76:28
alias: loop1
21:00:00:20:37:0c:76:85; \
21:00:00:20:37:0c:71:df
Effective configuration:
cfg:
USA_cfg
zone: Blue_zone
1,1
21:00:00:20:37:0c:76:8c
21:00:00:20:37:0c:71:02
1,2
21:00:00:20:37:0c:76:22
Fabric OS Command Reference
53-1003108-01
115
2
cfgShow
zone:
21:00:00:20:37:0c:76:28
Red_zone
1,0
21:00:00:20:37:0c:76:85
21:00:00:20:37:0c:71:df
To display only configuration names:
switch:admin> cfgshow "*"
cfg:
USA1
Blue_zone
cfg:
USA_cfg Red_zone; Blue_zone
To display changes in the current transaction:
switch:admin> cfgshow --transdiffs
Defined configuration:
cfg:
fabric_cfg Blue_zone
zone:
*zone:
Blue_zone
1,1; array1; 1,2; array2
green_zone
-1,1; 1,2; +6, 15
*zone: +red_zone
5,1; 4,2
alias: array1 21:00:00:20:37:0c:76:8c; \
21:00:00:20:37:0c:71:02
alias: array2 21:00:00:20:37:0c:76:22; \
21:00:00:20:37:0c:76:28
Effective configuration:
cfg:
fabric_cfg
zone: Blue_zone
1,1
21:00:00:20:37:0c:76:8c
21:00:00:20:37:0c:71:02
1,2
To display only the changes in the current transaction:
switch:admin> cfgshow --transdiffsonly
*zone: -Blue_zone
21:00:00:20:37:0c:76:8c
21:00:00:20:37:0c:71:02
SEE ALSO
116
*zone:
green_zone
1,1; -1,2;+5,4;+ 21:00:00:20:37:0c:76:55
*zone:
+red_zone
5,4; 5,6
cfgAdd, cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgSave,
cfgTransAbort, cfgTransShow
Fabric OS Command Reference
53-1003108-01
cfgSize
2
cfgSize
Displays zone and Admin Domain database size details.
SYNOPSIS
DESCRIPTION
cfgsize [integer]
Use this command to display the size details of the zone database and the Admin Domain database.
When executed in a non-AD255 context, the size details include maximum size, the committed size, and
the transaction size of the Zone database in bytes.
When executed in an AD255 context, this command displays the maximum size for the Admin Domain
and Zone database, the Admin Domain header size, and the zone database sizes for each Admin
Domain:
Zone DB maximum size
Defines the upper limit for both Zone and Admin Domain defined configuration,
determined by the amount of nonvolatile memory available for storing the defined
configuration. The Zone DB maximum size is further reduced due to a message
header that is propagated with the zone configuration to all switches in the fabric.
The maximum supported zone database size is 2 MB for chassis based switches
and 1 MB for other switches.
Available Zone DB size
Displays the size of the database that is actually available for storage.
Committed size
Displays the size of the defined configuration currently stored in nonvolatile
memory.
Transaction size
Displays the size of the uncommitted defined configuration. This value will be
nonzero if the defined configuration is being modified by Telnet, API, and so forth;
otherwise it is 0.
Refer to the cfgShow help page for a description of defined and effective zone configurations. Refer to
the ad help page for a description of the defined and the effective Admin Domain configurations.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
In Virtual Fabric environments, the zone database size of all partitions taken together cannot exceed 2
MB for chassis based switches and 1 MB for other switches. Exceeding the zone database size limit can
result in unexpected behavior. Note that in Virtual Fabric mode, the zone database limit is enforced per
partition, but not chassis-wide.
OPERANDS
The following operand is optional:
integer
If a nonzero integer is specified, the size of the nonvolatile memory allocated for
the zone database is displayed. The zone database includes both the defined and
effective configurations. The database size is displayed in bytes.
Fabric OS Command Reference
53-1003108-01
117
2
cfgSize
EXAMPLES
To display the zone database on a Brocade 6510
switch:admin> cfgsize
Zone DB max size - 1045274 bytes
Available Zone DB size - 1041503 bytes
committed - 2759
transaction - 0
To display Admin Domain and zone database size information in an AD255 context:
switch:admin> cfgsize
Maximum AD and Zone DB size
- 1045274 bytes
Total Committed AD and Zone DB size - 3390 bytes
AD and Zone DB uncommitted space available - 1041884 bytes
Total AD and Zone Transaction buffer size 0 bytes
AD Database Size:
---------------committed 3124 bytes
transaction 0 bytes
Number of ADs in Effective Configuration
- 4
Each AD's Zone Database Size:
---------------------------cfgsize Info for AD Number:0 (AD Name: AD0, State=Active):
committed 242 bytes
transaction 0 bytes
cfgsize Info for AD Number:1 (AD Name: AD1, State=Active):
committed - 16 bytes
transaction 0 bytes
SEE ALSO
118
cfgsize Info for AD Number:2
committed 4 bytes
transaction 0 bytes
(AD Name: AD2, State=Active):
cfgsize Info for AD Number:3
committed 4 bytes
transaction 0 bytes
(AD Name: AD3, State=Active):
ad, cfgShow, zoneHelp
Fabric OS Command Reference
53-1003108-01
cfgTransAbort
2
cfgTransAbort
Aborts the current zoning transaction.
SYNOPSIS
DESCRIPTION
cfgtransabort [token]
Use this command to abort the current zoning transaction without committing it. All changes made since
the transaction was started are removed and the zone configuration database is restored to the state
before the transaction was started.
If a transaction is open on a different switch in the fabric when this command is run, the transaction on
the other switch remains open and unaffected.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
When invoked without an operand, this command aborts the current transaction. The following operand
is optional:
token
Specify the token ID of the transaction to be aborted. Use the cfgTransShow
command to obtain the token ID of a transaction.
EXAMPLES
To abort the current transaction:
switch:admin> cfgtransabort
SEE ALSO
cfgAdd, cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgSave, cfgShow,
cfgTransShow
Fabric OS Command Reference
53-1003108-01
119
2
cfgTransShow
cfgTransShow
Displays information about the current zoning transaction.
SYNOPSIS
cfgtransshow
cfgtransshow --opentrans
cfgtransshow --help
DESCRIPTION
NOTES
Use this command to display the ID of the current zoning transaction. In addition, the command provides
information on whether or not the transaction can be aborted. The transaction cannot be aborted if it is an
internal zoning transaction.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When an FCS policy is enabled, this command can be issued only from the primary FCS switch.
OPERANDS
This command has the following operands:
--opentrans
Displays local open transaction token details and the list of domains with open
transactions.
--help
Displays the command usage.
EXAMPLES
To display the current transaction:
switch:admin> cfgtransshow
There is no outstanding zone transaction
switch:admin> cfgclear
Do you really want to clear all configurations?
(yes, y, no, n): [no] y
Clearing All zoning configurations...
\
switch:admin> cfgtransshow
Current transaction token is 271010736
It is abortable
120
Fabric OS Command Reference
53-1003108-01
cfgTransShow
2
To display the current transaction and the list of domains with open transactions:
switch:admin> cfgtransshow --opentrans
Current transaction token is 0x3109
It is abortable
Transactions Detect: Capable
Current Open Transactions
Domain List:
------------------------1 2 3 4
SEE ALSO
cfgAdd, cfgClear, cfgCreate, cfgDelete, cfgDisable, cfgEnable, cfgRemove, cfgSave, cfgShow,
cfgTransAbort
Fabric OS Command Reference
53-1003108-01
121
2
chassisBeacon
chassisBeacon
Sets chassis beaconing mode.
SYNOPSIS
DESCRIPTION
chassisbeacon [mode]
Use this command to enable or disable beaconing on a chassis. Chassis beaconing can be used to
locate a failing chassis in a group of chassis. Use the portBeacon command to locate a failing port, and
use the switchBeacon command to locate a failing (logical) switch.
When beaconing mode is turned on, the port LEDs flash green at various rates across the chassis. The
beaconing continues until you turn it off.
Beaconing mode takes over the port LEDs. The normal flashing LED pattern associated with an active,
faulty, or disabled port is suppressed, and only the beaconing pattern is shown. Other commands are still
executable and functional. However, if diagnostic frame-based tests such as portLoopbackTest are
executed, the diagnostic LED pattern is interleaved with the beaconing pattern.
The chassisBeacon command is one of three commands that control beaconing. Each command has a
clearly defined scope of action:
•
•
The portBeacon command enables or disables beaconing on a specified port.
•
The chassisBeacon command to enables or disables beaconing on all ports in the chassis.
The switchBeacon command enables or disables beaconing on all ports in the current logical
switch.
The actions of the beaconing commands are independent and mutually exclusive. For example, if you
enabled beaconing on the logical switch and you want to enable beaconing on the entire chassis, you
must first disable switch beaconing with the switchBeacon command before you can use the
chassisBeacon command to enable beaconing on the entire chassis. Likewise, existing portBeacon
settings remain unaffected if you enable or disable beaconing on the switch or on the chassis. Failure to
disable existing beaconing commands before using a different type of beaconing may cause the
commands to interfere with each other in unexpected ways.
To determine whether or not beaconing is enabled or disabled on the switch or chassis, use the
switchBeacon or chassisBeacon command without operands. A value of 0 indicates that the command
is disabled, a value of 1 indicates that the command is enabled. Issue the portBeacon --show command
to display beaconing for a specific port. The switchShow command displays the status of the
switchBeacon command only.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
mode
Specify 1 to enable chassis beaconing mode or 0 to disable beaconing mode.
This operand is optional. If no operand is specified, the current value is displayed.
EXAMPLES
To turn chassis beaconing mode on:
switch:admin> chassisbeacon 1
Chassis beacon success 1
To turn beaconing mode off:
switch:admin> chassisbeacon 0
Chassis beacon success 0
122
Fabric OS Command Reference
53-1003108-01
chassisBeacon
2
To display the chassis beaconing mode:
switch:admin> chassisbeacon
Value = 0
SEE ALSO
portBeacon, switchShow, switchBeacon
Fabric OS Command Reference
53-1003108-01
123
2
chassisCfgPerrThreshold
chassisCfgPerrThreshold
Configures parity error threshold and fault capability on a blade or switch.
SYNOPSIS
chassiscfgperrthreshold --enable [-threshold threshold_value]
chassiscfgperrthreshold --disable
chassiscfgperrthreshold --show
chassiscfgperrthreshold --help
DESCRIPTION
Use this command to enable or disable the fault capability on a blade and switch based on the parity
error threshold, to set the threshold value for parity errors, or to display the configuration. If the fault
capability is enabled, the state of the blade or switch changes to Faulty when the parity errors exceed the
threshold value within a time interval of 5 minutes. The default threshold value is 2. You can modify the
threshold using the -threshold threshold_value option.
The configuration is persistent across system reboots and high availability (HA) failover.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--enable
Enables the fault capability on a blade or switch. The default threshold value is 2.
The following operand is optional:
-threshold threshold_value
Specifies the threshold value for parity errors. The range is from 2 through 100.
--disable
Disables the fault capability on a blade or switch.
--show
Displays the configured threshold value and the current status of the fault
capability as enabled or disabled.
--help
Displays the command usage.
EXAMPLES
To enable fault capability:
switch:admin> chassiscfgperrthreshold --enable
To disable fault capability:
switch:admin> chassiscfgperrthreshold --disable
To enable fault capability and set the threshold value to 76:
switch:admin> chassiscfgperrthreshold --enable -threshold 76
124
Fabric OS Command Reference
53-1003108-01
chassisCfgPerrThreshold
2
To display the configuration:
switch:admin> chassiscfgperrthreshold --show
Configured Threshold is 76 and the Fault is enabled.
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
125
2
chassisDisable
chassisDisable
Disables all user ports in a chassis.
SYNOPSIS
DESCRIPTION
chassisdisable [-force]
Use this command to disable a Virtual Fabric-aware chassis. All Fibre Channel ports are taken offline.
This command prompts for confirmation unless the -force option is used. If the chassis is partitioned into
logical switches that are part of logical fabrics, the remaining switches in these fabrics reconfigure. As
each port is disabled, the front panel LED changes to a slow-flashing amber.
You must disable the chassis before making configuration changes or running offline diagnostic tests.
Commands that require the chassis to be disabled generate an error message if invoked while the
chassis is enabled. It is not necessary to disable a chassis before rebooting or powering off the switch.
To disable the ports of a single logical switch, use the switchDisable command. To disable the ports of a
single blade, use the bladeDisable command.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
-force
Disables the chassis without confirmation. This operand is optional.
EXAMPLES
To disable a chassis:
switch:admin> chassisdisable
This command can cause disruption to\
multiple logical switches.
Are you sure you want to disable all chassis ports now?\
(yes, y, no, n): [no]y
SEE ALSO
126
bladeDisable, bladeEnable, chassisEnable, switchShow, switchDisable, switchEnable,
switchCfgPersistentEnable, switchCfgPersistentDisable
Fabric OS Command Reference
53-1003108-01
chassisDistribute
2
chassisDistribute
Distributes IP filter policies.
SYNOPSIS
chassisdistribute -db ipfilter -fid target_FID [-force]
chassisdistribute -db ipfilter -domain target_domain_list [-force]
DESCRIPTION
Use this command to manually distribute the IP Filter policy database. The behavior of this command
depends on whether Virtual Fabrics are enabled or disabled.
•
If Virtual Fabrics are enabled on the originating switch, this command distributes the IP filter policy
database to all chassis that are connected through the specified logical switch (FID). If the target
chassis has Virtual Fabrics enabled, the IP filter policy database is distributed to all logical switches
configured on the target. If Virtual Fabrics are not enabled on the target, the IP filter policy database
is distributed to the default logical switch of the target.
•
If Virtual fabrics are disabled on the originating switch, the IP filter policy database is distributed to a
list of target switches specified by their Domain IDs. If a target domain has Virtual Fabrics enabled,
the IP filter policy database is distributed to all logical switches on the target domain. If Virtual
Fabrics are not enabled on the target domain, the IP filter policy database is distributed to the default
logical switch of the target domain.
This command distributes the entire IP Filter database and overwrites any existing IP Filter policies on
the receiving switches. The chassisDistribute command does not enforce FCS policy.
The target chassis or switches must be capable of accepting the distribution. The distribution is aborted if
one of the connected chassis or domains is configured to reject the distribution. Use the fddCfg
command to configure the fabric-wide policies that control distribution behavior.
When upgrading from pre-7.2.0 to 7.2.0 or later versions, the RPC port rules will be removed from the IP
Filter policy database.
The command output includes the following information:
FID
Indicates whether Virtual Fabrics are enabled or not on the domain that receives
the distribution. If Virtual Fabrics are enabled, the FID is displayed, and all logical
switches which are part of the chassis are targeted to receive the distribution.
DOMAIN
Displays the Domain ID of the originating switch.
CHASSISWWN
Displays the WWN of the originating or receiving chassis. Displays the originating
switch WWN in switches running Fabric OS versions that do not support the
chassis WWN feature.
CHASSISNAME
Displays the name of the chassis.
SUPPORTED_DIST
Displays yes if the distribution is supported on the receiving chassis. Displays no if
the distribution is not supported.
NOTES
This command distributes the IP Filter database only. To distribute other security databases, use the
distribute command.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Fabric OS Command Reference
53-1003108-01
127
2
chassisDistribute
OPERANDS
This command has the following operands:
-db ipfilter
Specifies the policy database to be distributed with this command. The only
accepted value for -db is ipfilter. The database name is case insensitive. The
legacy notation ("IPFILTER") still works but is not necessary. The following
operands are mutually exclusive:
-fid target_FID
Specifies the target logical switch for the distribution. The logical switch is
identified by its fabric ID (FID). When a FID is specified, the database is
distributed to all chassis that are connected to the specified logical switch (FID)
and are configured to accept the distribution. This operand is required and valid
only when the originating switch is in Virtual Fabric mode.
-domain target_domain_list
Specifies a list of target switch domain IDs that should receive the database. The
list must be enclosed in double quotation marks; members must be separated by
a semicolon. A wildcard (*) may be specified to include all switches in the fabric
that support the distribute feature. This operand is required and valid only when
Virtual Fabrics are disabled.
-force
Distributes the database without confirmation.
EXAMPLES
To distribute the IP Filter policies to all chassis that are connected through the logical fabric 128 and
support the distribute feature:
switch:admin> chassisDistribute -db ipfilter -fid 128
FID
DOMAIN
CHASSISWWN
CHASSISNAME SUPPORTED_DIST
--------------------------------------------------------128
3 10:00:00:05:1e:38:ac:0e DCX_93
yes
NON-VF 4 10:00:00:05:1e:39:bd:0f Brocade300
yes
128
98 10:00:00:05:1e:41:22:9f Brocade6510
no
chassisDistribute will distribute the database(s) to \
above topology.
Would you like to continue [Y/N] : y
ChassisDistribute operation succeeded for above topology
To distribute the IP Filter policies to all switches in the fabric that support the distribute feature (Virtual
Fabrics are disabled on the evoking switch):
switch:admin> chassisDistribute -db ipfilter -domain "*"
FID
DOMAIN
CHASSISWWN
CHASSISNAME SUPPORTED_DIST
-------------------------------------------------------128
3 10:00:00:05:1e:38:ac:0e DCX_93
no
NON-VF 4 10:00:00:05:1e:39:bd:0f Brocade300
yes
128
98 10:00:00:05:1e:41:22:9f Brocade6510
no
ChassisDistribute will distribute the database(s) to \
above topology.
Would you like to continue [Y/N] : y
ChassisDistribute operation succeeded for above topology
SEE ALSO
128
distribute, fddCfg
Fabric OS Command Reference
53-1003108-01
chassisEnable
2
chassisEnable
Enables all user ports in a chassis.
SYNOPSIS
DESCRIPTION
chassisenable
Use this command to enable a Virtual Fabric-aware chassis. All Fibre Channel ports that passed the
power-on self test (POST) are enabled. They may come online if connected to a device, or remain offline
if disconnected. Use chassisEnable to re-enable the chassis after making configuration changes or
running offline diagnostics.
If the chassis is partitioned into multiple logical switches and physically connected to multiple logical
fabrics, the logical switches rejoin their fabrics.
As each port is enabled, the front panel LED changes from slow-flashing amber to nonflashing green for
online ports, or to nonflashing amber for ports that do not initialize. Disconnected ports remain unlit.
Loopback ports slowly flash green when online.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable a chassis:
switch:admin> chassisenable
SEE ALSO
bladeDisable, bladeEnable, chassisDisable, switchShow, switchDisable, switchEnable,
switchCfgPersistentEnable, switchCfgPersistentDisable
Fabric OS Command Reference
53-1003108-01
129
2
chassisName
chassisName
Displays or sets the chassis name.
SYNOPSIS
DESCRIPTION
chassisname [name]
Use this command to display or change the name associated with the chassis.
Use this command without parameters to display the current chassis name. Use this command with the
name operand to assign a new chassis name.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
name
Specify a new name for the chassis, optionally in double quotation marks. A
chassis name can include up to 31 characters. A chassis name must begin with a
letter, and can consist of letters, numbers, underscore or hyphen characters.
Spaces are not permitted.
EXAMPLES
To change the chassis name to "dilbert":
switch:admin> chassisname dilbert
switch:admin> chassisname
dilbert
SEE ALSO
130
switchName
Fabric OS Command Reference
53-1003108-01
chassisShow
2
chassisShow
Displays all field replaceable units (FRUs).
SYNOPSIS
DESCRIPTION
chassisshow
Use this command to display the Field Replaceable Unit (FR) header content for each object in the
chassis and chassis backplane version. This command displays the following information:
1.
The chassis family, for example, DCX 8510.
2.
The backplane version number, in hexadecimal: Chassis Backplane Revision: xx
3.
The first line of each record contains the object ID. If the FRU is part of an assembly, a brief
description is displayed in parentheses.
a.
Object type: CHASSIS, FAN, POWER SUPPLY, SW BLADE (switch), CP BLADE (control
processor), WWN (world wide name), or UNKNOWN.
b.
Object number: Slot nn (for blades), Unit nn (for everything else).
4.
FRU header version number: Header Version: x
5.
Displays the maximum allowed power consumption for a given hardware component: positive for
power supplies and negative for power consumers. The combined total maximum allowed power
consumption for the entire chassis is shown in the output of the slotShow -p command. Power
Consume Factor: -xxx
6.
Displays the real-time power consumption for each FRU that supports real-time power
measurement. Only 16Gb blades currently support real time measurement of power being
consumed by these blades. When the capability is not supported for a FRU, the line is suppressed.
Power Usage (Watts):
7.
Factory part number (up to 14 characters): Factory Part Num: xx-xxxxxx-xx
8.
Factory serial number (up to 12 characters): Factory Serial Num:xxxxxxxxxx
9.
FRU manufacture date: Manufacture: Day: dd Month: mm Year: yyyy
10. Date of the last FRU header update: Update: Day: dd Month: mm Year: yyyy
11. Cumulative number of days the FRU has been powered on: Time Alive: dddd days
12. Time elapsed, in days, since the FRU was last powered on: Time Awake: dddd days
13. Externally supplied ID (up to 10 characters): ID: xxxxxxxxxx
14. Externally supplied part number (up to 20 characters): Part Num: xxxxxxxxxxxxxxxxxxxx
15. Externally supplied serial number (up to 20 characters): Serial Num: xxxxxxxxxxxxxxxxxxx
16. Externally supplied revision number (up to 4 characters): Revision Num: xxxx
The output of this command depends on the platforms on which it is executed. On some platforms, for
certain FRU types, a few items may not be available. In these cases, the lines are suppressed. Possibly
affected lines are 1, 3 through 7, 9, and 11 through 14. In addition, for lines 11 through 14, if there is no
data set, these lines are suppressed.
Fabric OS Command Reference
53-1003108-01
131
2
chassisShow
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the FRUs for a DCX 8510-8:
switch:user> chassisshow
Chassis Family:
DCX8510-8
Chassis Backplane Revision: 0
SW BLADE Slot: 1
Header Version:
Power Consume Factor:
Power Usage (Watts):
Factory Part Num:
Factory Serial Num:
Manufacture:
Update:
Time Alive:
Time Awake:
2
-180
-286
60-1002144-02
BQB0345F00G
Day: 9 Month: 11
Day: 19 Month: 2
41 days
1 days
SW BLADE Slot: 2
Header Version:
Power Consume Factor:
Power Usage (Watts):
Factory Part Num:
Factory Serial Num:
Manufacture:
Update:
Time Alive:
Time Awake:
2
-180
-306
60-1002144-02
BQB0345F02R
Day: 21 Month: 11
Day: 19 Month: 2
41 days
1 days
SW BLADE Slot: 3
Header Version:
Power Consume Factor:
Power Usage (Watts):
Factory Part Num:
Factory Serial Num:
Manufacture:
Update:
Time Alive:
Time Awake:
(output truncated)
SEE ALSO
132
2
-180
-315
60-1002144-02
BQB0345F01N
Day: 16 Month: 11
Day: 19 Month: 2
39 days
1 days
Year: 2010
Year: 2011
Year: 2010
Year: 2011
Year: 2010
Year: 2011
slotShow
Fabric OS Command Reference
53-1003108-01
classConfig
2
classConfig
Displays RBAC class permissions.
SYNOPSIS
classconfig --show class_name | -all | -classlist
classconfig --showcli command
classconfig --showroles class_name
classconfig --help
DESCRIPTION
Use this command to display information about role-based access control (RBAC) permissions for one or
all meta-object format (MOF) classes, to display permissions for a specified command, or to display the
permissions for a specified MOF class.
Fabric OS commands are grouped into feature sets called MOF classes. For example, the commands
ldapCfg, passwd, passwdCfg, and userConfig are all related to User Management and are therefore
grouped together under a MOF class called UserManagement.
The pre-defined roles Root, Factory, Admin, User, SwitchAdmin, ZoneAdmin, FabricAdmin,
BasicSwitchAdmin, SecurityAdmin and Operator provide a mechanism for further restricting access to
commands of a certain class by role-specific permissions. For example, a user with the ZoneAdmin role
will have access to the commands under the MOF class Zoning but not to those under the
UserManagement class.
The following RBAC permissions are supported in Fabric OS:
•
•
•
O = observe
OM = observe-modify
N = no access
Note that the MOF class level permissions extend to all commands in that class, but not necessarily to
each and every command option. For example, a command may have the RBAC class permission of
"OM", but a show only option under that command may have the permission "O". At the role level, a
certain role may be excluded from viewing the command information, in which case the permission for
that role would be "N".
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following optional operand:
--show
Displays RBAC permission information. One of the following operands is required:
class_name or -all
Displays permissions for a single MOF class or for all classes. The output displays
the class name, the CLIs grouped under the specified class, the command
options, and the RBAC class permissions for each command option.
-classlist
Displays an alphabetical listing of all MOF classes supported in Fabric OS.
Fabric OS Command Reference
53-1003108-01
133
2
classConfig
--showcli command
Displays the RBAC permissions for the specified command and associated
command options. The output displays the command name, the command
options, the RBAC class permissions for each command option, the MOF class,
and the context restriction for the command in VF mode only. If the length of a row
is too long to fit in one line, the strings displayed under RBAC Class and Option
column will be split and displayed in two lines.
--showroles class_name
Displays the role permissions the specified MOF class.
--help
Displays the command usage.
EXAMPLES
To display an alphabetical listing of all MOF classes supported in Fabric OS:
switch:admin> classconfig --show -classlist
List of RBAC classes:
1. AdminDomains
2. ADSelect
3. AG
4. APM
5. Audit
6. Authentication
7. Blade
8. ChassisConfiguration
9. ChassisManagement
10. ConfigManagement
11. Configure
12. DCE
13. Debug
14. Diagnostics
15. DMM
16. EncryptionConfiguration
17. EncryptionManagement
18. EthernetConfig
19. Fabric
20. FabricDistribution
21. FabricRouting
22. FabricWatch
23. Factory
24. FCoE
25. FICON
26. FIPSBootprom
27. FIPSCfg
28. FirmwareKeyManagement
29. FirmwareManagement
30. FRUManagement
31. HA
32. IPfilter
33. IPSec
34. ISCSI
35. License
36. LocalUserEnvironment
37. Logging
38. LogSupportsave
39. ManagementAccessConfiguration
40. ManagementServer
41. NameServer
42. Nocheck
43. NxPortManagement
134
Fabric OS Command Reference
53-1003108-01
classConfig
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
2
PhysicalComputerSystem
PKI
PortMirror
RADIUS
Reboot
Restricted
RoleConfig
RoutingAdvanced
RoutingBasic
Security
SessionManagement
SNMP
Statistics
StatisticsDevice
StatisticsPort
SwitchConfiguration
SwitchManagement
SwitchManagementIPConfiguration
SwitchPortConfiguration
SwitchPortManagement
Topology
USBManagement
UserManagement
WWNCard
Zoning
To display the RBAC permissions for the commands included in the UserManagement class:
switch:admin> classconfig --show UserManagement
RBAC class Name : UserManagement
CLI
Option
Permission
------------------------------------------------------ldapcfg
help
O
ldapcfg
maprole
OM
ldapcfg
show
O
ldapcfg
unmaprole
OM
passwd
OperandPresent
OM
passwdcfg
disableadminlockout OM
passwdcfg
enableadminlockout
OM
passwdcfg
help
O
passwdcfg
set
OM
passwdcfg
setdefault
OM
passwdcfg
showall
O
userconfig
add
OM
userconfig
addad
OM
userconfig
addlf
OM
userconfig
change
OM
userconfig
delete
OM
userconfig
deletead
OM
userconfig
deletelf
OM
userconfig
showad
O
userconfig
showlf
O
userconfig
showuser
O
userrename
OM
Fabric OS Command Reference
53-1003108-01
135
2
classConfig
To display the RBAC permissions for the UserManagement class:
switch:admin> classconfig --showroles UserManagement
Roles that have access to the RBAC class 'usermanagement' are:
Role Name
--------Admin
Factory
Root
SecurityAdmin
Permission
---------OM
OM
OM
OM
To display the RBAC permissions for a command:
switch:admin> classconfig --showcli classconfig
CLI
Option
Permission RBAC Class
Context
---------------------------------------------------------classconfig
help
O
RoleConfig
chassis
classconfig
show
O
RoleConfig
chassis
classconfig
showcli
O
RoleConfig
chassis
classconfig
showroles O
RoleConfig
chassis
To display the RBAC permissions for a command (in the following example, the command option entries
are split and displayed in two lines because the length of the rows is too long):
switch:admin> classconfig --showcli ag
CLI
Option
Permission
RBAC Class
----------------------------------------------------ag
addwwnfailov OM
AG
ermapping
ag
ag
addwwnmappin
g
addwwnpgmapp
ing
OM
AG
OM
AG
[...]
SEE ALSO
136
roleConfig
Fabric OS Command Reference
53-1003108-01
cliHistory
2
cliHistory
Displays switch command history.
SYNOPSIS
clihistory
clihistory --show
clihistory --showuser username
clihistory --showall
clihistory --help
DESCRIPTION
This command saves the following information whenever a command is executed on the switch:
•
•
•
•
•
Timestamp
Username
IP address of the Telnet session
Options
Arguments
This command displays the local CLI command history. The information is saved in the SSHOW_SYS file
as part of supportSave. The CLI history is saved persistently to compact flash. The maximum number of
saved entries for this command is 1680. CLI history records is wrapped after reaching the maximum limit
specified.
The CLI history is wrapped and saved in a file that is persistent across reboots and firmware download.
Only the command name is stored in the CLI history for commands that requires password; no
arguments are stored.
This command can also be executed on the standby CP.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
--show
Displays the CLI history of the current user.
--showuser username
Displays the CLI history of the given user.
--showall
Displays the CLI history of all users.
--help
Displays the command usage.
EXAMPLES
To display the command history on a switch:
switch:admin> clihistory
Date & Time
Wed Jul 25 22:35:43 2012
Wed Jul 25 22:35:48 2012
Wed Jul 25 22:35:51 2012
Fabric OS Command Reference
53-1003108-01
Message
admin, 10.70.12.103, help ag
admin, 10.70.12.103, help zone
admin, 10.70.12.103, version
137
2
cliHistory
switch:admin> firmwaredownload -s -p scp 10.70.4.109,fvt,/dist,pray4green
Server IP: 10.70.4.109, Protocol IPv4
Checking system settings for firmwaredownload...
Failed to access scp://fvt:**********@10.70.4.109//dist/release.plist
switch:admin> clihistory
Date & Time
Message
Wed May 23 03:39:37 2012
admin, console, firmwaredownload
SEE ALSO
138
None
Fabric OS Command Reference
53-1003108-01
cmsh
2
cmsh
Opens the CEE command shell.
SYNOPSIS
DESCRIPTION
cmsh
Use this command to open a shell for managing 10 GbE interfaces and Layer2/Layer3 protocol services.
The CEE management shell provides a hierarchical CLI interface.
Refer to the CEE Command Reference and the CEE Administrator's Guide for information on how to use
the CEE commands and configuration procedures.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To run FCoE using the minimum switch configuration:
switch:admin> cmsh
admin>en
admin>#conf t
Enter configuration commands, one per line. End with CNTL/Z.
admin>(config)#int te 0/0
admin>(config-if)#sw
admin>(config-if)#no shut
admin>(config-if)#exit
admin>(config)#exit
admin>#show ip int br
Interface IP-Address Status Protocol
TenGigabitEthernet 0/0 unassigned up up
TenGigabitEthernet 0/1 unassigned administratively down down
TenGigabitEthernet 0/2 unassigned administratively down down
TenGigabitEthernet 0/3 unassigned administratively down down
TenGigabitEthernet 0/4 unassigned administratively down down
TenGigabitEthernet 0/5 unassigned administratively down down
TenGigabitEthernet 0/6 unassigned administratively down down
TenGigabitEthernet 0/7 unassigned administratively down down
TenGigabitEthernet 0/8 unassigned administratively down down
TenGigabitEthernet 0/9 unassigned administratively down down
TenGigabitEthernet 0/10 unassigned administratively down down
TenGigabitEthernet 0/11 unassigned administratively down down
TenGigabitEthernet 0/12 unassigned administratively down down
TenGigabitEthernet 0/13 unassigned administratively down down
TenGigabitEthernet 0/14 unassigned administratively down down
TenGigabitEthernet 0/15 unassigned administratively down down
TenGigabitEthernet 0/16 unassigned administratively down down
TenGigabitEthernet 0/17 unassigned administratively down down
TenGigabitEthernet 0/18 unassigned administratively down down
TenGigabitEthernet 0/19 unassigned administratively down down
TenGigabitEthernet 0/20 unassigned administratively down down
TenGigabitEthernet 0/21 unassigned administratively down down
TenGigabitEthernet 0/22 unassigned administratively down down
TenGigabitEthernet 0/23 unassigned administratively down down
switch:admin>#exit
Fabric OS Command Reference
53-1003108-01
139
2
cmsh
To create an FCoE VLAN:
switch:admin> cmsh
switch:admin>en
switch:admin>#conf t
switch:admin>(config)#protocol lldp
switch:admin>(conf-lldp)# advertise dcbx-fcoe-app-tlv
switch:admin>(conf-lldp)# advertise dcbx-fcoe-logical-link-tlv
switch:admin>(conf-lldp)#exit
switch:admin>(config)#exit
switch:admin>(config)#
fcoe encap ethv2
switch:admin>(config)#
encap ethv2
switch:admin>(config)#
switch:admin>(config)#
vlan classifier rule 1 proto \
vlan classifier rule 2 proto fip \
vlan classifier group 1 add rule 1
vlan classifier group 1 add rule 2
switch:admin>(config)#interface vlan 5
switch:admin>(conf-if-vl-5 )#fcf forward
switch:admin>(conf-if-vl-5 )exit
switch:admin>(config) # cee-map test
switch:admin>(conf-ceemap) # priority-group-table 1 \
weight 40 pfc
switch:admin>(conf-ceemap) # priority-group-table 2 \
weight 60
switch:admin>(conf-ceemap) # priority-table 2 2 2 1 2 2 2 2
switch:admin>(conf-ceemap) # exit
switch:admin>(config)#interface te 0/0
switch:admin>(config-if-te-0/0)#switchport
switch:admin>(config-if-te-0/0)#switchport mode access
switch:admin>(config-if-te-0/0)# vlan classifier activate \
group 1 vlan 5
switch:admin>(config-if-te-0/0)# cee test
switch:admin>(config-if-te-0/0)#no shutdown
switch:admin>(config-if-te-0/0)#exit
switch:admin>(config)#exit
switch:admin>#exit
SEE ALSO
140
fcoe, fcoeLoginCfg, fcoeLoginGroup
Fabric OS Command Reference
53-1003108-01
configDefault
2
configDefault
Resets the nonpersistent configuration data to factory defaults.
SYNOPSIS
DESCRIPTION
configdefault [-fid FID | -all | -switch]
Use this command to reset the nonpersistent configuration settings to their factory default values.
Configuration data is grouped into chassis information and switch information. Each configuration type is
managed separately. The behavior of configDefault depends on the environment in which the command
is executed:
•
In a Virtual Fabric environment, when executed without operands, this command resets the switch
configuration to default values on the current logical switch only. An Admin with chassis permissions
can use additional parameters to reset configuration data for a specified logical switch (-fid FID) or
for all logical switches and the chassis (-all).
•
In a non-Virtual Fabric environment, when executed without operands, this command resets the
switch configuration. When executed with the -all operand, configDefault resets all of the system's
configuration data, including chassis and switch configurations. The -switch option resets the switch
configuration only. The -fid option is not valid.
This command resets nonpersistent configuration parameters only. The following parameters are not
affected by this command:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Ethernet MAC address, IP address, subnet mask, and boot ROM parameters
IP gateway address
License keys
OEM customization
Product ID and Vendor ID
SNMP configuration
System name
Chassis name
World wide name
Zoning configuration (includes aliases, zones, and configurations)
Security parameters and policies
User account passwords (includes all user configuration and all built-in accounts)
Switch PID format
Ethernet Link Mode
Refer to the help files for configure and configureChassis help for more information on default values
for configuration parameters.
NOTES
This command cannot be executed on an enabled switch. You must first disable the switch using
switchDisable or chassisDisable.
Some configuration parameters are cached by the system. To avoid unexpected system behavior, reboot
the system after executing configDefault.
Note that configDefault does not completely remove all FCIP tunnels and GbE IP address information.
This may be an issue when attempting to use the same information to create new tunnels or modify the
existing ones.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Fabric OS Command Reference
53-1003108-01
141
2
configDefault
OPERANDS
This command has the following operands:
-fid FID
Specifies the Fabric ID of the logical switch for which to reset the configuration.
This operand is valid only in Virtual Fabric mode, and the executing account must
have chassis permissions.
-all
Restores all nonpersistent configuration parameters to factory default values
(switch and chassis parameters). This command requires chassis permissions.
-switch
Resets the switch configuration only. This operand is not valid in VF mode.
EXAMPLES
To restore all system configuration parameters to default values:
switch:admin> configdefault -all
Executing configdefault...Please wait
Setting the default config: FID = 128 Switch Name =stinger78
Already in Native Mode continuing with configDefault
Committing configuration ... done.
The switch has to be rebooted to allow the changes to take effect.
Do you want to reboot the system (y/n) [y]: y
SEE ALSO
142
snmpConfig, configure, configureChassis, switchDisable, switchEnable
Fabric OS Command Reference
53-1003108-01
configDownload
2
configDownload
Downloads configuration data to the system.
SYNOPSIS
configdownload
configdownload [- all ] [-p ftp | -ftp] ["host","user","path"
[,"passwd"]]
configdownload [- all ] [-p scp | -scp ] ["host","user","path"]
configdownload [- all ] [-p sftp | -sftp ] ["host","user","path"]
configdownload [- all ] [-local | -USB | -U ["file"]]
configdownload [-fid FID | -chassis | -all | -switch]
[-p ftp | -ftp ] ["host","user","path" [,"passwd"]]
configdownload [-fid FID | -chassis | -all | -switch ]
[-p scp | -scp ] ["host","user","path"]
configdownload [-fid FID | -chassis | -all | -switch ]
[-p sftp | -sftp ] ["host","user","path"]
configdownload [-fid FID | -chassis | -all | -switch]
[-force] [-local | -USB | -U ["file"]]
configdownload [-vf] [-p ftp | -ftp ] ["host","user","path"
[,"passwd"]]
configdownload [ -vf] [-p scp | -scp ] ["host","user","path"]
configdownload [ -vf] [-p sftp | -sftp ] ["host","user","path"]
configdownload [-vf] [-local | -USB | -U ["file"]]
DESCRIPTION
This command downloads configuration parameters to the local system. Two types of configuration files
can be downloaded with this command: Virtual Fabric configuration parameters and system configuration
parameters. You must download both types of configuration data for the system to behave as expected.
You can use FTP or SCP to download configuration files from a remote host, or you can retrieve the
configuration files from a predetermined directory on the local system, or from an attached USB device.
Use the -vf option to download the Virtual Fabric configuration parameters. The Virtual Fabric
configuration file includes logical switch definitions and Virtual Fabric status (enabled or disabled). The
file should be named switch-conf_xx.txt to distinguish it from the regular system configuration (config.txt).
The xx indicates the platform ID. Virtual Fabric configuration data can only be shared between switches
that belong to the same platform type and share the same platform ID. If the platform ID contained in the
header of the configuration file does not match the platform ID of the system to which it is downloaded,
configDownload fails. When you download a switch-conf_xx.txt file, all attributes defined in this file are
downloaded to the system and take effect with the exception of LISL ports. The LISL ports on the system
are not affected by this download.
Fabric OS Command Reference
53-1003108-01
143
2
configDownload
The system configuration data is downloaded separately. It is grouped into chassis information and
switch information. Each configuration type is managed separately and the behavior of configDownload
depends on the environment in which the command is executed and which part of the system
configuration you wish to download.
•
In a Virtual Fabric environment, when executed without chassis permissions, this command
downloads the switch configuration to the current logical switch only. An Admin user with chassis
permissions can use additional parameters to perform the following selective configuration
downloads:
-
Download the switch configuration to a specified logical switch (-fid FID).
Download the chassis configuration only (-chassis).
Download the entire configuration including the data for all logical switches and for the chassis
(-all).
The interactive version of the command (no operands) prompts for input on only the parameters the
user is allowed to execute.
•
In a non-Virtual Fabric environment, this command by default downloads the configuration for the
default logical switch only. To download the chassis-level configuration only, use the -chassis
option. To download both the chassis and switch configuration, use the -all option. Chassis
permissions are required. The -fid option is not valid. The -switch option is equivalent to issuing the
command default (without options).
The switch must be disabled for configuration download of all parameters with the exception of SNMP
and Fabric Watch.
The following rules apply to configuration download in Virtual Fabric mode:
•
When downloading the chassis configuration, the number of logical switches defined in the
configuration download must match the number of logical switches currently defined on the switch.
•
When downloading the switch configuration, the target FID must be defined in both the configuration
download and the current system.
•
When downloading the switch configuration from a specified source FID to a target FID, the target
FID must be defined on the switch and the source FID and associated configuration must be defined
in the configuration download. In addition, downloading an SFID configuration resets the target FID
ports without warning. Caution is advised when using this option.
•
When downloading all configuration parameters, the number of switches defined in the downloaded
configuration file must match the number of switches currently defined on the switch. In addition, the
following restrictions apply:
-
The switches must be disabled unless you only wish to download SNMP or Fabric Watch
parameters.
-
Downloading a configuration file from a system that is not Virtual Fabric-capable to a system in
Virtual Fabric mode is not recommended. The configuration is applied to the default switch only,
and only to the ports that are part of the default switch.
-
Downloading a Virtual Fabrics configuration file with the -vf option to a switch that has Admin
Domains configured is not permitted, and the command fails with a warning message. Virtual
Fabrics and Admin Domains cannot coexist on the same switch.
If an FCS policy is enabled, the following rules and restrictions apply:
144
•
Both [Defined Security Policies] and [Active Security Policies] sections must exist and contain the
FCS_POLICY.
•
In the [Defined Security Policies] section, at least one member of the FCS_POLICY must be the
same as a member in the previous FCS_POLICY.
•
In the [Active Security Policies] section, the FCS_POLICY must be exactly the same as the previous
FCS_POLICY. Order of members must be maintained.
•
If either security policies section has an RSNMP_POLICY, then that section must have a
WSNMP_POLICY.
Fabric OS Command Reference
53-1003108-01
configDownload
2
•
After the switch is enabled, if the switch is the primary FCS, then its security and zoning information
is propagated to all other switches in the fabric.
•
After the switch is enabled, if the switch is a non-FCS or a backup FCS, then its security and zoning
information will be overwritten by the primary FCS.
Security parameters and the switch identity cannot be changed by configDownload. Parameters such
as the switch name and IP address are ignored; they are lines in the configuration file that begin with
"boot". Security parameters and version stamp are ignored; they are the lines in the configuration file that
begin with "sec".
[License] is only accepted if the boot.mac parameter matches the license ID (WWN) of the switch
performing the download; otherwise, it is ignored.
The configuration parameters R_A_TOV, E_D_TOV, WAN_TOV, and MAX_HOPS are interrelated.
Assigning a specific value to one or more of these parameters might change the range of allowed values
that can be assigned to the other parameters. As a result, you may not be able to set all the values within
the range displayed for each parameter. This command validates the modified values of these four
parameters and terminates the download operation, if the validation check fails.
This is particularly important when downloading a zoning configuration. Because the new zoning
information is added to the current configuration, there might not be any conflicts. If the current zoning
configuration is to be replaced, the keyword "clear:" should be inserted into the configuration file
immediately before the zoning lines (starting at the line "[Zoning]").
If the configuration file contains the keyword "enable:" followed by a zone_configuration, that zoning
configuration is enabled in the fabric. If there is no "enable:" keyword in the configuration file or no zoning
configuration by that name exists, or if enable fails for any reason (such as dangling aliases), then the
following conditions apply:
NOTES
•
The effective configuration remains as it was prior to the configuration download. The "enable:"
action is ignored.
•
The Defined Configuration changes to reflect the new zoning configuration.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
If the switch is in Access Gateway mode, some of the configuration parameters will take effect only after
the switch has been re-enabled with the switchEnable command.
F_Port trunking configurations are not saved in the configuration file and will not be restored after a
configuration download.
Do not manually edit a configuration file after uploading the file and before downloading the file to a
switch. Manual editing bypasses sanity checks for some configuration parameters and results in
unpredictable system behavior.
The configDownload command prompts for confirmation and issues a notice that "A switch reboot is
required for the changes to take effect." A configuration download affects large amount of configuration
data, and there is no reliable mechanism to determine, which of these parameters may or may not
require a reboot. To ensure that all configuration changes are applied correctly, Brocade strongly
recommends that you always reboot the switch after a configuration download.
OPERANDS
This command has the following operands:
-p ftp | -ftp or -p scp | -scp or -p sftp | -sftp
Specifies the data transmission protocol as either file transfer protocol (FTP),
secure copy protocol (SCP), or secure FTP (SFTP). If no protocol is specified, the
protocol defaults to FTP.
Fabric OS Command Reference
53-1003108-01
145
2
configDownload
-vf
Downloads the Virtual Fabric configuration (switch-conf_xx.txt) instead of the
regular system configuration. The switch-con_xx.txt file contains a listing of logical
switches configured on the platform specified by the platform ID (xx) and other
Virtual Fabric parameters. You cannot use the -vf option with any of the system
configuration upload options (-fid, -chassis, -all).
-all
Downloads all configuration data, including chassis and switch configuration data.
-fid FID
Downloads the switch configuration to a logical switch specified by its fabric ID.
This operand is valid only in a Virtual Fabric environment and requires chassis
permissions.
-chassis
Downloads the chassis configuration only.
-switch
Downloads the switch configuration only. This operand is valid only in non-VF
mode.
"host"
Specifies the name or the IP address of the external host, from which to download
the configuration. IPv4 and IPv6 addresses are supported. To be able to mention
the FTP server by name, you need to set up two DNS servers with dnsConfig.
Quotation marks are optional.
"user"
Specifies the login name for the external host. Quotation marks are optional.
"path"
Specifies the file name and path of the configuration file. Absolute path names
may be specified using a forward slash (/). Relative path names search for the file
in the login account's home directory on UNIX hosts and in the directory on which
the FTP server is running on Windows hosts. This operand is valid only when the
file is downloaded from an external host. Quotation marks are optional.
"passwd"
Specifies the account password. Quotation marks are optional.
-local
Downloads a specified configuration file from a predetermined directory on the
local chassis.
-USB | -U
Downloads a specified configuration file from a predetermined directory on an
attached USB device.
"file"
Specifies the name of the configuration file to be downloaded. This parameter can
be used only with the -local or -USB option, each of which retrieves files from a
predetermined directory on the local chassis or on an attached USB device.
Therefore, subdirectories and absolute path names are not permitted. Quotation
marks are optional.
-force
Overwrites an existing file without confirmation. This parameter is valid only with
the -local or -USB options.
146
Fabric OS Command Reference
53-1003108-01
configDownload
DIAGNOSTICS
EXAMPLES
2
The configuration download may fail for one or more of the following reasons:
•
The switch has not been disabled. Disabling the switch is not necessary for configuration files
containing only certain SNMP or Fabric Watch parameters. You can run configDownload first
without disabling the switch, and if there is at least one changed parameter outside of Fabric Watch
or SNMP, you are prompted to disable the switch before proceeding.
•
•
•
•
•
•
•
•
•
•
The host name is not known to the switch.
The host IP address cannot be contacted.
You do not have permission on the host.
You are running a script that prints something at login.
The file does not exist on the host.
The file is not a switch configuration file.
The FTP server is not running on the host.
The configuration file contains errors.
The configuration file's logical switch definitions do not match the definitions on the target switch.
Admin Domains are configured on the switch, and you attempt to download a Virtual Fabrics
configuration file.
To download the switch configuration file interactively to the current logical switch from a local directory
(no chassis permissions):
switch:admin> configdownload
Protocol (scp, ftp, sftp, local) [ftp]:
Server Name or IP Address [host]: 192.168.163.233
User Name [user]: admin
Path/Filename [<home dir>/config.txt]:
Section (all|chassis|FID# [all]):
*** CAUTION ***
This command is used to download a backed-up configuration
for a specific switch. If using a file from a different
switch, this file's configuration settings will override
any current switch settings.
Downloading a configuration
file, which was uploaded from a different type of switch,
may cause the switch to fail.
A switch reboot is required for the changes to take effect.
Please make sure all the switches are disabled by
using chassisdisable command. Downloading configuration
to an online switch may result in some configuration not
being downloaded to that switch.
configDownload operation may take several minutes
to complete for large files.
Do you want to continue [y/n]: y
Password: *******
Activating configDownload: Switch is disabled
configDownload complete: All config parameters are downloaded
To download the switch configuration data to the current logical switch from an external FTP server (no
chassis permissions):
switch:admin> configdownload -ftp 192.168.38.245, \
jdoe,config.txt,password
Fabric OS Command Reference
53-1003108-01
147
2
configDownload
To download all system configuration data for the chassis and all logical switches (requires chassis
permissions):
switch:admin> configdownload -all -ftp 192.168.38.245, \
jdoe,config.txt,password
To download the switch configurations to a logical switch with FID 8 from an attached USB device
(requires chassis permissions):
switch:admin> configdownload -fid 8 -USB config.txt
To download the switch configurations belonging to a logical switch with FID 4 to a logical switch with FID
8 from an attached USB device (requires chassis permissions):
switch:admin> configdownload -fid 8 -sfid 4
-USB config_fid8.txt
\
To download the Virtual Fabric configuration file using secure FTP:
switch:admin> configdownload -vf -p sftp \
10.32.248.119,jdoe,/temp/switch-conf_66.txt,mypassword
To attempt to download the Virtual Fabric configuration interactively to a switch with configured Admin
Domains:
switch:admin> configdownload -vf -p sftp \
10.32.248.119,jdoe,/temp/switch-conf_66.txt,mypassword
*** CAUTION ***
This command is used to download the VF configuration to the
switch. Afterwards, the switch will be automatically rebooted
and the new VF settings will be used. You will then need to
run configdownload again to install the configuration(s) for
any logical switch(s) that are setup in the new VF configuration.
Please note that Virtual Fabrics and Admin Domains are mutually
exclusive and are not supported at the same time on a switch.
If any Admin Domains are configured on the switch, the
configdownload operation will fail.
Do you want to continue [y/n]: y
jdoe@10.32.248.119's password:
Error: configDownload operation failed. VF/AD Conflict detected.
Please remove all ADs before downloading the VF configuration to
the switch.
2011/06/12-17:14:02, [CONF-1023], 3637, FID 128, INFO, sw0,
configDownload failed for VF config parameters.
SEE ALSO
148
configDefault, configList, configShow, configUpload, configure, configRemove
Fabric OS Command Reference
53-1003108-01
configList
2
configList
Lists uploaded configuration files.
SYNOPSIS
DESCRIPTION
NOTES
OPERANDS
configlist -local | -USB | -U
This command displays a list of names, sizes, and creation dates of configuration files saved on the local
chassis or on an attached USB device. These files are created when the configUpload command is
executed with the -local or the -USB option.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-local
Displays the list of configuration files on the local chassis.
-USB | -U
Displays the list of configuration files on the attached USB device.
EXAMPLES
To display a list of configuration files stored on the local chassis:
switch:admin> configlist -local
config.txt
25679
2007 Jan 02 15:16
config2.txt
25679
2007 Jan 06 15:16
next_cfg.txt
20977
2007 Jan 18 15:16
SEE ALSO
configDownload, configUpload, configShow, configRemove
Fabric OS Command Reference
53-1003108-01
149
2
configRemove
configRemove
Deletes a saved configuration file.
SYNOPSIS
DESCRIPTION
NOTES
OPERANDS
configremove -local | -USB | -U [file]
This command deletes a configuration file that was previously saved to the local chassis or to an
attached USB device by using the configUpload command.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-local
Removes a configuration file that was previously created by configUpload -local
from the local chassis.
-USB | -U
Removes a configuration file that was previously created by configUpload -USB
from an attached USB device.
file
Specifies the configuration file to be removed. If the file option is omitted, the
command prompts for a file name.
EXAMPLES
To remove a configuration file from the local chassis:
switch:admin> configremove -local first_config.txt
To remove a configuration file from an attached USB device without specifying a filename:
switch:admin> configremove -USB
File Name [config.txt]: second_config.txt
SEE ALSO
150
configDownload, configUpload, configList, configShow
Fabric OS Command Reference
53-1003108-01
configShow
2
configShow
Displays system configuration settings.
SYNOPSIS
configshow
configshow [-all | -fid FID | -chassis | -switch] |
[-local | -USB | -U] [file] [-pattern "pattern"]
DESCRIPTION
Use this command to display system configuration settings. Some but not all of these parameters are set
by the configure and configureChassis commands.
Configuration data is grouped into chassis information and switch information. Each configuration type is
managed separately. The behavior of configShow depends on the environment in which the command
is executed:
NOTES
•
In a Virtual Fabric environment, when executed without operands, this command displays the switch
configuration for the current logical switch. An Admin with chassis permissions can use additional
parameters to display configuration data for a specified logical switch (-fid FID), for the chassis
(-chassis), or for all logical switches and the chassis (-all).
•
In a non-Virtual Fabric environment, when executed without operands, this command displays the
switch configuration. When executed with the -all operand, configShow displays all of the system's
configuration data, including chassis and switch configuration data. The -chassis option displays the
chassis configuration only. The -switch option displays the switch configuration only. The -fid option
is not valid.
Not all values displayed are applicable to all system models and configurations.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
The following operands are optional:
-pattern "pattern"
Specifies a text string, enclosed in double quotation marks, that limits the output of
the command to only those entries that contain the pattern. Use of wildcards and
other common regular expression operators is not supported. Some configuration
settings do not display when filtered. When in doubt, use the command without
the -pattern operand. Executing configShow -pattern without further operands is
not recommended and can cause unspecified behavior.
-all
Displays all configuration data including chassis and switch configuration.
-fid FID
Displays configuration data for a logical switch specified by its fabric ID. This
option is valid only in a Virtual Fabric environment and requires chassis
permissions
-chassis
Displays configuration data for the chassis only. This option is valid only in a
Virtual Fabric environment and requires chassis permissions
-switch
Displays the switch configuration only. This option is valid only in a Non-Virtual
Fabric environment.
Fabric OS Command Reference
53-1003108-01
151
2
configShow
-local [file]
Displays the content of a configuration file that was previously created by
configUpload and stored on the chassis. The output can be optionally filtered by
-pattern "pattern". If file is omitted, the command prompts for a file name. The
output format when -local is specified matches that of configUpload and
contains a superset of the information provided when -local is not specified.
-USB | -U [file]
Displays the content of a configuration file that was previously created by
configUpload and stored on an attached USB device. The output can be
optionally filtered by -pattern "pattern". If file is omitted, the command prompts for
a file name. The output format when -USB is specified matches that of
configUpload and contains a superset of the information provided when -USB is
not specified.
EXAMPLES
To display all configuration data on a Virtual Fabric-enabled system:
switch :admin> configshow -all
[Configuration upload Information]
Configuration Format = 3.0
Minimum Compatible Format = 3.0
Excluding Format = 0.0
date = Sun May 26 06:18:40 2013
FOS version = v7.2.0
Number of LS = 2
[Chassis Configuration Begin]
[fcRouting]
fcRoute.backboneFabricId:100
fcRoute.fcrState:2
fcRouteParam.maxLsanCount:3000
fcRoute.port.8.xportAdmin:DISABLED
fcRoute.port.8.fabricId:4
fcRoute.port.8.ratov:10000
fcRoute.port.8.edtov:2000
fcRoute.port.8.frontConfigDid:160
fcRoute.port.8.portType:400
fcRoute.port.8.portMode:0
fcRoute.port.8.autoElp:7
fcRoute.port.9.xportAdmin:DISABLED
fcRoute.port.9.fabricId:5
fcRoute.port.9.ratov:10000
fcRoute.port.9.edtov:2000
fcRoute.port.9.frontConfigDid:160
fcRoute.port.9.portType:400
fcRoute.port.9.portMode:0
fcRoute.port.9.autoElp:7
fcRouteParam.port.8.rportCost:0
fcRouteParam.port.9.rportCost:0
fcRoute.xlate.persistxdState:1
fcRouteParam.lsan.tagCnt:0
[Chassis Configuration]
passwdcfg.minlength:8
passwdcfg.lowercase:0
passwdcfg.uppercase:0
passwdcfg.digits:0
passwdcfg.punctuation:0
passwdcfg.history:1
passwdcfg.minpasswordage:0
152
Fabric OS Command Reference
53-1003108-01
configShow
2
passwdcfg.maxpasswordage:0
passwdcfg.warning:0
passwdcfg.lockoutthreshold:0
passwdcfg.lockoutduration:30
passwdcfg.adminlockout:0
passwdcfg.repeat:1
passwdcfg.sequence:1
passwdcfg.status:0
fips.mode:0
fips.selftests:0
ipfilter.0.name:default_ipv4
ipfilter.0.numofrules:12
ipfilter.0.rule.1:0,0x23,0,0,6,22
ipfilter.0.rule.10:0,0x23,0,0,17,123
ipfilter.0.rule.11:0,0x63,0,0,6,600,1023
ipfilter.0.rule.12:0,0x63,0,0,17,600,1023
ipfilter.0.rule.2:0,0x23,0,0,6,23
ipfilter.0.rule.3:0,0x23,0,0,6,897
ipfilter.0.rule.4:0,0x23,0,0,6,898
ipfilter.0.rule.5:0,0x23,0,0,6,111
ipfilter.0.rule.6:0,0x23,0,0,6,80
ipfilter.0.rule.7:0,0x23,0,0,6,443
ipfilter.0.rule.8:0,0x23,0,0,17,161
ipfilter.0.rule.9:0,0x23,0,0,17,111
ipfilter.0.state:3
ipfilter.0.type:0
ipfilter.1.name:default_ipv6
ipfilter.1.numofrules:12
ipfilter.1.rule.1:0,0x23,0,0,6,22
ipfilter.1.rule.10:0,0x23,0,0,17,123
ipfilter.1.rule.11:0,0x63,0,0,6,600,1023
ipfilter.1.rule.12:0,0x63,0,0,17,600,1023
ipfilter.1.rule.2:0,0x23,0,0,6,23
ipfilter.1.rule.3:0,0x23,0,0,6,897
ipfilter.1.rule.4:0,0x23,0,0,6,898
ipfilter.1.rule.5:0,0x23,0,0,6,111
ipfilter.1.rule.6:0,0x23,0,0,6,80
ipfilter.1.rule.7:0,0x23,0,0,6,443
ipfilter.1.rule.8:0,0x23,0,0,17,161
ipfilter.1.rule.9:0,0x23,0,0,17,111
ipfilter.1.state:3
ipfilter.1.type:1
(output truncated)
To filter the content to display only the password configuration:
switch :admin> configshow -all -pattern "passwdcfg"
passwdcfg.minlength:8
passwdcfg.lowercase:0
passwdcfg.uppercase:0
passwdcfg.digits:0
passwdcfg.punctuation:0
passwdcfg.history:1
passwdcfg.minpasswordage:0
passwdcfg.maxpasswordage:0
passwdcfg.warning:0
passwdcfg.lockoutthreshold:0
Fabric OS Command Reference
53-1003108-01
153
2
configShow
passwdcfg.lockoutduration:30
passwdcfg.adminlockout:0
passwdcfg.repeat:1
passwdcfg.sequence:1
passwdcfg.status:0
To display switch configuration data for FID 20:
switch :admin> configshow -fid 20
[Configuration upload Information]
Configuration Format = 2.0
date = Tue Oct 7 14:53:12 2008
FOS version = v6.2.0.0
Number of LS = 3
[Switch Configuration Begin : 0]
SwitchName = Spirit_66
Fabric ID = 20
[Boot Parameters]
boot.name:Spirit_66
boot.ipa:10.32.228.66
boot.licid:10:00:00:05:1e:41:5c:c1
boot.mac:10:00:00:05:1e:41:5c:c1
boot.device:eth0
boot.gateway.ipa:10.32.224.1
[Configuration]
acl.clear:0
ag.port.nfportfailback:0x0
ag.port.nfportfailover:0x0
ag.port.nfporttopo.0:0x0
ag.port.nfporttopo.1:0x0
ag.port.nfporttopo.10:0x0
ag.port.nfporttopo.11:0x0
ag.port.nfporttopo.12:0x0
ag.port.nfporttopo.13:0x0
ag.port.nfporttopo.14:0x0
ag.port.nfporttopo.15:0x0
ag.port.nfporttopo.16:0x0
ag.port.nfporttopo.17:0x0
ag.port.nfporttopo.18:0x0
ag.port.nfporttopo.19:0x0
ag.port.nfporttopo.2:0x0
ag.port.nfporttopo.20:0x0
(output truncated)
SEE ALSO
154
configure, configureChassis, configDownload, configUpload, configList, configRemove,
diagDisablePost, diagEnablePost, ipAddrShow, licenseShow, syslogdIpShow
Fabric OS Command Reference
53-1003108-01
configUpload
2
configUpload
Uploads system configuration data to a file.
SYNOPSIS
configupload
configupload [-all] [-p ftp | -ftp] ["host","user","path"
[,"passwd"]]
configupload [-all] [-p scp | -scp] ["host","user","path"]
configupload [-all] [-p sftp | -sftp] ["host","user","path"]
configupload [-all] [-force] [-local | USB |-U] ["file"]
configupload [-fid FID | -chassis | -all | -switch]
[-p ftp | -ftp]["host","user","path" [,"passwd"]]
configupload [-fid FID | -chassis | -all | -switch]
[-p scp| -scp]["host","user","path"]
configupload [-fid FID | -chassis | -all | -switch]
[-p sftp | -sftp]["host","user","path"]
configupload [-fid FID | -chassis | -all] | -switch]
[-force] [-local | USB | -U] ["file"]
configupload [-vf] [-p ftp | -ftp] ["host","user","path"
[,"passwd"]]
configupload [-vf] [-p scp | -scp] ["host","user","path"]
configupload [-vf] [-p sftp | -sftp] ["host","user","path"]
configupload [-vf] [-force] [-local | USB |-U] ["file"]
DESCRIPTION
This command uploads configuration data to a file. Two types of configuration files can be uploaded with
this command: Virtual Fabric configuration parameters and system configuration parameters.
Use the -vf option to upload Virtual Fabric configuration parameters. The Virtual Fabric configuration
includes logical switch definitions and Virtual Fabric status (enabled or disabled). The file should be
named switch-conf_xx.txt to distinguish it from the regular system configuration (config.txt). The xx
indicates the platform ID specified in the header of the configuration file. The platform ID is the same as
the first two digits of the "switchType" parameter displayed by switchShow. Virtual Fabric configuration
data can only be shared between switches that belong to the same platform type and share the same
platform ID. Refer to configDownload help for more information on the Virtual Fabric configuration.
Fabric OS Command Reference
53-1003108-01
155
2
configUpload
The system configuration data is uploaded separately. It is grouped into chassis information and switch
information. Each configuration type is managed separately and the behavior of configUpload depends
on the environment in which the command is executed and which part of the system configuration you
wish to upload.
•
In a Virtual Fabric environment, when executed without chassis permissions, this command uploads
the current logical switch configuration only. An Admin user with chassis permissions can use
additional parameters to perform the following selective configuration uploads:
-
Upload the switch configuration of a specified logical switch (-fid FID).
-
Upload the switch configuration only in Non-VF mode(-switch).
Upload the chassis configuration only (-chassis).
Upload the entire system configuration including the data for all logical switches and for the
chassis (-all).
The interactive version of the command (no operands) prompts for input on only the parameters the
user is allowed to execute.
•
In a non-Virtual Fabric environment, this command by default uploads the configuration for the
default logical switch only. To upload the chassis-level configuration only, use the -chassis option.
To upload both the chassis and switch configuration, use the -all option. Chassis permissions are
required. The -fid option is not valid. The -switch option is equivalent to issuing the command
default (without options).
You can use the file transfer protocol (FTP), the secure copy protocol (SCP), or secure FTP (SFTP) to
upload configuration files to an external host, or you can save the configuration in a predetermined
directory on the local chassis or on an attached USB device. If the specified file already exists, this
command prompts you to overwrite the file. Specify -force to overwrite the file without confirmation.
When the local chassis is chosen as the destination, the resulting file is written to both primary and
secondary partitions, and on enterprise-class platforms, to both Active and Standby Control Processors
(CPs).
Refer to the Fabric OS Administrator's Guide for information on backward compatibility, on configuration
upload and download in Admin Domains (AD), and on the content of the configuration file.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
F_Port trunking configurations are not saved in the configuration file and will not be restored after a
configuration download.
Do not manually edit a configuration or a switch-conf.xx file after uploading the file and before
downloading the file to a switch. Manual editing bypasses sanity checks for some configuration
parameters and results in unpredictable system behavior.
OPERANDS
This command has the following operands:
-p ftp | -ftp or -p scp | -scp or -p sftp | -sftp
Specifies the data transmission protocol as either file transfer protocol (FTP),
secure copy protocol (SCP), or secure FTP (SFTP). If no protocol is specified, the
protocol defaults to FTP.
-vf
Uploads the Virtual fabric configuration to a file. You must specify a filename when
uploading this file. It is recommended to name this file switch-conf_xx.txt (where
xx indicates the platform ID) to distinguish this file from the system configuration
(config.txt). Use switchShow to determine the platform ID of the system. The
platform ID in the header of the configuration file is the same as the first two digits
of the switchType parameter in the switchShow output. You cannot use the -vf
option with any of the regular configuration upload options (-fid, -chassis, -all).
156
Fabric OS Command Reference
53-1003108-01
configUpload
2
-fid FID
Uploads switch configuration data from a logical switch specified by its fabric ID.
This parameter is valid only in a Virtual Fabric environment and requires chassis
permissions.
-chassis
Uploads chassis configuration only.
-all
Uploads all system configuration data including chassis and switch configuration
for all logical switches.
-switch
Uploads the switch configuration only. This operand is not valid in VF mode.
"host"
Specifies the name or the IP address of the external host to which to upload the
configuration. To be able to mention the FTP server by name, you need to set up
one or more DNS servers with dnsConfig. Quotation marks are optional.
"user"
Specifies the login name for the external host. Quotation marks are optional.
"path"
Specifies the file name and path of the configuration file. Absolute path names
may be specified using a forward slash (/). Relative path names upload the file to
the login account's home directory on UNIX hosts and into the directory on which
the FTP server is running on Windows hosts. This operand is valid only when the
file is uploaded to an external host. Quotation marks are optional.
"passwd"
Specifies the account password. Quotation marks are optional.
-local
Uploads a specified configuration file to a predetermined directory on the local
chassis. This option requires a file name.
-USB | -U
Uploads a specified configuration file to a predetermined directory on an attached
USB device. This option requires a file name.
"file"
Specifies the file name. Quotation marks are optional. This parameter is valid only
with the -local or -USB options, each of which stores files in a predetermined
directory on the local chassis or on an attached USB device. Therefore,
subdirectories and absolute path names are not permitted.
-force
Overwrites an existing file without confirmation. This parameter is valid only with
the -local or -USB options.
When invoked without operands or without "host" or "file" parameters, configUpload runs in interactive
mode.
DIAGNOSTICS
The configuration upload may fail for one or more of the following reasons:
•
•
•
•
The host name is not known to the switch.
The host IP address cannot be contacted.
The user does not have permission on the host.
The FTP server is not running on the host.
Fabric OS Command Reference
53-1003108-01
157
2
configUpload
EXAMPLES
To upload the switch configuration interactively from a switch that is not enabled for Virtual Fabrics:
switch:admin> configupload
Protocol (scp, ftp, sftp, local) [ftp]: sftp
Server Name or IP Address [host]: 192.168.38.245
User Name [user]: jdoe
File Name [<home dir>/config.txt]:
Section (all|chassis|switch [all]):
Password: ******
configUpload complete: All config parameters are uploaded
To upload the switch configuration that belongs to a logical switch with FID 100:
switch:admin> configupload
Protocol (scp, ftp, sftp, local) [ftp]: sftp
Server Name or IP Address [host]: 10.32.220.100
User Name [user]: jdoe
File Name [<home dir>/config.txt]: config.fid100.txt
Section (all|chassis|FID# [all]): 100
Password: ******
configUpload complete: All config parameters are uploaded
To upload the configuration for the entire chassis to a local file from the command line forcing an
overwrite:
switch:admin> configupload -chassis -local
-force config.txt
\
configUpload complete: All config parameters are uploaded
To upload the configuration for the current logical switch to an external FTP server:
switch:admin> configupload -ftp 192.168.38.245, \
jdoe,config.txt,password
To upload all system configuration data to an external FTP server:
switch:admin> configupload -all -ftp \
192.168.38.245,jdoe,config.txt,password
To upload the system configuration file for a logical switch with FID 8 to an attached USB device:
switch:admin> configupload -fid 8 \
-USB config.txt
To upload the Virtual Fabric configuration of the current platform to an external FTP server:
switch:admin> configupload -vf -p ftp \
10.32.248.119,jdoe,/temp/switch-conf.66.txt,password
SEE ALSO
158
configDefault, configDownload, configShow, configList, configRemove, configure,
configureChassis
Fabric OS Command Reference
53-1003108-01
configure
2
configure
Changes switch configuration settings.
SYNOPSIS
DESCRIPTION
configure
Use this command to change switch configuration settings.
Configuration data is grouped into chassis information and switch information. Each configuration type is
managed separately. For information on file format and specific parameters contained in each section,
refer to the configUpload help page.
The behavior of the configure command depends on the environment in which the command is
executed:
•
In a Virtual Fabric environment, the configure command sets switch configuration parameters for
the current logical switch only. If a switch or chassis is configured with multiple logical switches, you
must configure each logical switch separately. Use the setContext command to change the current
logical switch context.
•
In a non-Virtual Fabric environment, the configure command sets switch configuration parameters.
To configure chassis-wide parameters, use the configureChassis command.
The following switch configuration parameters can be set with the configure command:
•
•
•
•
•
•
•
•
•
•
•
Switch fabric parameters
Virtual channel parameters
F_Port login parameters
Zoning operation parameters
Remote State Change Notifications (RSCN) transmission mode
Arbitrated Loop parameters
System Services settings
Portlog Events enable or disable settings
Secure Socket Layer (SSL) attributes
Remote Procedure Call Daemon (RPCD) attributes
Web Tools attributes
To access all parameters controlled by this command, you must disable the switch using the
switchDisable command. If executed on an enabled switch, only a subset of attributes are configurable.
Menu displays may vary depending on the hardware platform.
The configure command runs in interactive mode and presents you with a series of hierarchical menus.
Each top-level menu and its associated submenus consist of a text prompt, a selection of valid values,
and a default value (in brackets).
The following keys control the execution of the command:
Return
When entered at a prompt with no preceding input, the command accepts the
default value (if applicable) and moves to the next prompt.
Interrupt (Ctrl-C)
Aborts the command immediately and ignores all changes made.
End-of-file (Ctrl-D)
When entered at a prompt with no preceding input, terminates the command and
saves changes made.
Fabric OS Command Reference
53-1003108-01
159
2
configure
The following parameters can be modified with the configure command:
Fabric Parameters
Fabric settings control the overall behavior and operation of the fabric. Some of these settings, such as
the domain, are assigned automatically and may differ from one switch to another in a given fabric. Other
parameters, such as buffer-to-buffer credit or timeout values, can be modified to suit specific applications
or operating environments but must be in agreement among all switches to allow formation of the fabric.
The following fabric settings can be modified (* = multiplication symbol)
Field
Type
Default Range
__________________________________________________
Domain
Number
1
1-239
Enable 8-bit
Dynamic Area Mode
Boolean
0
0 or 1
WWN Based persistent PID
Boolean
no
yes/no
Dynamic D-Port
Boolean
on
on/off
Allow XISL Use
Boolean
yes
yes/no
Location ID
Number
0
0 to 4
Disable FID Check
Boolean
no
yes/no
Enable a 256 Area Limit
Number
0
0 to 2
R_A_TOV
Number
10000
E_D_TOV * 2
to 120000
E_D_TOV
Number
2000
1000 to
R_A_TOV/2
WAN_TOV
Number
0
0 to R_A_TOV/4
MAX_HOPS
Number
7
7 to 19
Data Field Size
Number
2112
256 to 2112
Sequence Level Switching
Boolean
0
0 or 1
Disable Device Probing
Boolean
0
0 or 1
Suppress Class F Traffic
Boolean
0
0 or 1
Per-frame Route Priority
Boolean
0
0 or 1
Long Distance Fabric
Boolean
0
0 or 1
BB Credit
Number
16
1 to 27
Disable FID Check
Boolean
yes
yes/no
Insistent Domain ID Mode
Boolean
no
yes/no
Disable Default PortName
Boolean
no
yes/no
Edge hold time
Number
220
80 to 500
Fabric parameters are defined as follows:
Domain
The domain number uniquely identifies a switch in a fabric. This value is
automatically assigned by the fabric. The range is 1-239.
Enable 8-bit Dynamic Area Mode
When enabled, this feature supports Dynamic Area Mode in default partitions on
the Brocade DCX, DCX-4S, DCX 8510-8, and DCX 8510-4. Dynamic Area Mode
is disabled by default. When enabled, Dynamic Area Mode supports both static
and dynamic area assignment. Use the portAddress command to perform a
static assignment of an area to a given port. In Dynamic Area Mode, areas are
dynamically assigned to the ports (up to a 255 limit). Port area assignments are
persistent; however, disabling Dynamic Area Mode with configure resets the area
assignments. This feature is configurable only on the default switch.
Enabling Dynamic Area Mode fails under one or more of the following conditions:
•
•
160
The number of ports in the default partition exceeds 255.
An AP blade with FL ports is present in the chassis (Brocade Encryption
blade, or FCoE 10-24.
Fabric OS Command Reference
53-1003108-01
configure
2
WWN Based persistent PID
When enabled, this feature supports both dynamic and static WWN-based PID
assignment. In dynamic PID binding, the first area assigned to a device when it
logs in is bound to the device WWN and remains persistent through subsequent
logins. Every time the device logs into the switch, it is guaranteed to get the same
PID. Alternately, you can use the wwnAddress command to create a static
WWN-based PID assignment. In either case, the WWN-based persistent PID
feature must be enabled through configure. The feature is disabled by default; it
is dependent on Dynamic Area Mode being enabled.
Dynamic D-Port
Disables or enables Dynamic D_Port mode configuration on the switch. By
default, Dynamic D_Port mode is ON. When Dynamic D_Port mode is ON, the
port may dynamically go into D_Port mode based on external request from remote
HBA or device port. After the D_Port tests are complete, the port may
automatically switch to operate as an F_Port. This option is not supported in AG
mode.
Allow XISL Use
An extended interswitch link (XISL) is an interswitch link (ISL) that connects the
logical switch to the base switch and carries traffic for multiple logical fabrics. This
feature is supported only on Virtual Fabric-aware platforms under the following
conditions: Virtual Fabrics must be enabled on the switch, and the switch cannot
be a base switch. In addition, on the Brocade DCX, DCX-4S, DCX 8510-8, and
DCX 8510-4 the switch cannot be a default switch or include interchassis link
(ICL) ports. This feature is enabled by default (yes=enabled). On the Brocade
5100, 5300, VA-40FC, and 6510 default switch, the feature is disabled by default
(no=disabled). Beginning with Fabric OS v7.0.0, the XISL feature is supported on
the Brocade extension blade (FX8-24).
You do not need to disable the logical switch before changing the value of this
parameter. Turning off XISL use requires confirmation because all LISLs will be
removed upon execution. If the logical switch is enabled and is part of an edge
fabric connected to an FCR, this parameter cannot be turned on. If the logical
switch is disabled or it is not yet part of an edge fabric, this parameter can be
turned on. However, execution may cause edge fabric segmentation if the
EX_Port connected to the edge fabric is disabled while the logical switch is
enabled or connected to the edge fabric. The Brocade 7800 VF configuration
does not support XISL usage and therefore this option is not available on this
logical switch.
Location ID
The Location ID parameter is reserved for future use and it must remain
unchanged with the default value of 0.
Disable FID Check
If fabric ID (FID) check is disabled, the fabric ignores the Fabric Identifier conflict
with the neighboring switch during fabric formation. By default, FID check is
enabled. If the fabric detects a FID conflict, it disables the E_Port with a "Fabric ID
conflict" message. This parameter is configurable only if the switch is Virtual
Fabric-aware and Virtual Fabric is enabled on the switch.
Enable 256 Area limit
The 256 area limit allows the partition to be configured for 8-bit addressing rather
than the default 10-bit addressing. Each port in this partition is given a unique
area represented by the middle 8 bits of the PID. Valid values include the
following:
0
No limit is imposed on the area. This is the default value. The partition is
configured for 10-bit addressing and supports up to 1800 ports.
Fabric OS Command Reference
53-1003108-01
161
2
configure
1
The unique area assignments begin at zero regardless of where the port is
physically located. This allows FICON users to make use of high port count port
blades with port indexes greater than 256.
2
The unique area assignments are based on the port index. This mode does not
allow FICON users to make use of ports with an index greater than 256 (high ports
of a high port count blade), but this mode is compatible with domain-index zoning.
This parameter is configurable only if the switch is Virtual Fabric-aware and Virtual
Fabric is enabled on the switch.
R_A_TOV
The resource allocation time out value specified in milliseconds. This variable
works with the variable E_D_TOV to determine switch actions when presented
with an error condition.
Allocated circuit resources with detected errors are not released until the time
value has expired. If the condition is resolved prior to the time out, the internal
time-out clock resets and waits for the next error condition.
E_D_TOV
Error detect time out value specified in milliseconds. This timer is used to flag a
potential error condition when an expected response is not received within the set
time limit. If the time for an expected response exceeds the set value, then an
error condition occurs.
WAN_TOV
Wide area network time out value specified in milliseconds. This timer is the
maximum frame time out value for a WAN, if any, interconnecting the Fibre
Channel islands.
MAX_HOPS
Maximum hops is an integer that denotes the upper limit on the number of hops a
frame might have to traverse to reach any destination port from any source port
across the fabric.
Note that the R_A_TOV, E_D_TOV, WAN_TOV, and MAX_HOPS configuration
parameters are interrelated. Assigning a specific value to one or more of these
parameters can change the range of allowed values that can be assigned to the
other parameters. As a result, you may not be able to set all the values within the
range displayed against each parameter. To reduce problems, the configuration
utility validates the modified parameter values and prompts you to re-enter some
values, if the validation check fails.
Data Field Size
The data field size specifies the largest possible value, in bytes, for the size of a
type 1 (data) frame. The switch advertises this value to other switches in the fabric
during construction of the fabric as well as to other devices when they connect to
the fabric. Setting this parameter to a value smaller than 2112 might result in
decreased performance.
Sequence-Level Switching
When sequence-level switching is set to 1, frames of the same sequence from a
particular source are transmitted as a group. When this feature is set to 0, frames
are transmitted interleaved among multiple sequences.
Under normal conditions, sequence-level switching should be disabled for better
performance. However, some host adapters have performance issues when
receiving interleaved frames from multiple sequences. When there are such
devices attached to the fabric, sequence-level switching should be enabled.
162
Fabric OS Command Reference
53-1003108-01
configure
2
Disable Device Probing
When disable device probing is set to 1, devices that do not register with the
Name Server will not be present in the Name Server data base. Set this mode
only if the switch's N_Port discovery process (PLOGI, PRLI, INQUIRY) causes an
attached device to fail.
Suppress Class F Traffic
By default, the switch can send Class F frames. When this option is turned on,
Class F traffic is converted to Class 2 traffic before being transmitted.
Per-frame Route Priority
In addition to the eight virtual channels used in frame routing priority, support is
also available for per-frame-based prioritization when this value is set. When
Per-frame Route Priority is set to 1, the virtual channel ID is used in conjunction
with a frame header to form the final virtual channel ID.
Long Distance Fabric
When this mode is set to 1, ISLs in a fabric can be up to 100 km long. The exact
distance level is determined by the per-port configuration on the E_Ports of each
ISL. Both E_Ports in an ISL must be configured to run the same long-distance
level; otherwise, the fabric will be segmented.
An Extended Fabrics license is required to set this mode.
BB Credit
The buffer-to-buffer (BB) credit represents the number of buffers available to
attached devices for frame receipt. The range of allowed values varies depending
on other system settings (see Unicast-only Operation). Refer to the Fabric OS
Administrator's Guide for more information on platform-specific BB Credit
limitations.
Insistent Domain ID Mode
When this mode is set, the switch attempts to acquire from the fabric the domain
number programmed in its "Switch Fabric Settings." If the operation fails, the
switch will segment from the fabric. You must disable the switch before configuring
this parameter.
Disable Default PortName
When this mode is set, the switch does not generate a default port name.
Edge hold time
Configures the maximum time a frame can wait after it is received on the ingress
port and before it is delivered to the egress port. If the frame waits in the egress
buffer for more than the configured hold time, the switch drops the frame,
replenishes sender's credit, and increments the counters er_tx_c3_timeout and
er_rx_c3_timeout on the TX and RX ports respectively. The frame-timeout
indicates a slow draining or a congestion or bottleneck in the fabric. Decreasing
hold time on the edge switches may reduce frame drop counts in the core
switches. This parameter is stored persistently in the configuration file. You can
configure edge hold time on both default and logical switch.
The edge hold time configuration is a chip-based value and the configuration
varies between Condor2-based platforms and Condor3-based platforms.
Condor2-based platform provides one register to store the edge hold time value
and any change in this value will affect all ports in the chip. Therefore, the edge
hold time configuration will not be changed for Condor2-based platform ports in a
logical switch. The Condor2-based platform ports in a logical switch take the
default edge hold time value (220 milliseconds) or the value configured in the
default switch. Condor3-based platform provides four registers to store the edge
hold time configuration and therefore each port in a chip can be configured one of
the four values.
Fabric OS Command Reference
53-1003108-01
163
2
configure
The edge hold time parameter is enabled by default with a value of 220
milliseconds. The following are the three predefined edge hold time values:
80
Low edge hold time (in milliseconds).
220
Medium edge hold time (in milliseconds). This is the default value.
500
High edge hold time (in milliseconds).
User Defined
A user-defined value may be defined in the range of 80 - 500 milliseconds in
increments of one. This value is only applicable to the default switch.
In a logical switch, the edge hold time configuration is updated only for Condor3
ports. If Condor2 ports are present in the logical switch, the SWCH-1025 RASLog
message is triggered to indicate that Condor2 ports are present and the edge hold
time configuration will not change for these ports.
Virtual Channel Settings
VC Priority specifies the class of frame traffic given priority for a virtual channel. The switch enables
fine-tuning for a specific application by configuring the parameters for eight virtual channels. The first two
virtual channels are reserved for switch internal functions and are not available for modification.
The default virtual channel settings have already been optimized for switch performance. Changing the
default values can improve switch performance but can also degrade performance. Do not change these
settings without fully understanding the effects of the changes.
The values for virtual channel settings are as follows:
Field
Default
Range
____________________________________
VC Priority 2
2
2 to 3
VC Priority 3
2
2 to 3
VC Priority 4
2
2 to 3
VC Priority 5
2
2 to 3
VC Priority 6
3
2 to 3
VC Priority 7
3
2 to 3
F_Port Login Parameters
Specifies the F_Port login parameters. The following F_Port login settings are configurable. Unless there
are issues with F_Port staging, do not change default values. (* = multiplication symbol)
Field
Type
Default
Range
________________________________________________________________
Maximum logins
Number For directors:
1 to
per switch
16 * the max number 126 * the max
of physical ports
Logins per second
Number 0
0 to 100
Login stage interval
(milli-seconds)
Number 0
0 to 10000
Stage FDISC logins
with busy rejects:
Number 0
1 to 255
Enforce FLOGI/FDISC
login:
Number 0
0 to 1
MAX num. of FLOGIs
allowed
Number 100
0 to 100
164
Fabric OS Command Reference
53-1003108-01
configure
2
Maximum logins per switch
Sets a switch-wide limit on allowed logins. The maximum login per switch has
decreased with Fabric OS v6.4.0. When upgrading from pre-v6.4.0 firmware
versions, the configured maximum is carried forward and may exceed the v6.4.0
limit. It is recommended to reconfigure this parameter to be within the range
permitted in Fabric OS v6.4.0.
The following three parameters are related to staged F_Port logins by FLOGI requests and virtual device
logins by FDISC(SID==0) requests.
Logins per second
Specifies the number of logins the switch accepts per second in staged F_Port
bring up.
Login stage interval
Specifies the stage interval in staged F_Port bring up.
Stage FDISC logins with busy reject:
This parameter, if nonzero, enables staging of FDISC logins by rejecting the
FDISC requests with "logical busy", when the requests are more than the number
of configured "logins per second". It also specifies the number of FDISC requests
that will always be accepted first without reject.
Enforce FLOGI/FDISC login
Setting this flag allows a second F_Port login (FLOGI/FDISC login) in the event of
two devices attempting to log in with the same PWWN. In default mode (zero) the
first FLOGI/FDISC login takes precedence over the second. When the mode is set
to 1, the second FLOGI/FDISC login takes precedence over the first. All modes
are for NPIV and non-NPIV F-Ports. When mode is set to 2, on FLOGI login the
first FLOGI takes precedence. On FDISC login, the second FDISC takes
precedence. For more information, refer to "Configure FLOGI-time handling of
duplicate PWWNs" section in the Fabric OS Administrator's Guide. You must
disable the switch to change this parameter.
MAX num. of FLOGIs allowed
Specifies the number of FLOGIs the port can accept per second. The default
value is 100. When the FLOGI limit is reached, the port will be fenced.
Zoning Operation Parameters
The following zoning operation parameter can be modified.
Disable NodeName Zone Checking
Specify 1 to disable using node WWN when specifying nodes in the zone
database. Specify 0 to enable using node WWN when specifying nodes in the
zone data. The default value is 0. This value must be set to 1 for interpretability.
RSCN Transmission Mode
The RSCN transmission modes and values are as follows:
End-device RSCN Transmission Mode
Values are as follows:
0
RSCN only contains single PID
1
RSCN contains multiple PIDs (Default)
2
Fabric addresses RSCN
Fabric OS Command Reference
53-1003108-01
165
2
configure
Domain RSCN to End-device
Values are as follows:
0
Disabled. No domain RSCN is sent to the end-device for the switch IP address or
name change.
1
Enabled. Domain RSCN is sent to the end-device for the switch IP address or
name change.
Arbitrated Loop Parameters
Arbitrated Loop Parameter and their values are as follows:
Send FAN frames?
Specifies that fabric address notification (FAN) frames be sent to public loop
devices to notify them of their node ID and address. When set to 1, frames are
sent; when set to 0, frames are not sent. The default value is 1.
Enable CLOSE on OPEN received?
If this is set, a CLS is returned immediately to an OPN if no buffers are available.
This is required for TachLite. The valid range is 0 to 4. The default value is 0.
Always send RSCN?
Following the completion of loop initialization, a remote state change notification
(RSCN) is issued when FL_Ports detect the presence of new devices or the
absence of preexisting devices. When set to 1, an RSCN is issued upon
completion of loop initialization, regardless of the presence or absence of new or
preexisting devices. When set to 0, an RSCN is not sent (default).
System Services Settings
The values for the System Services settings are as follows:
Disable RLS probing
Enables or disables the read link status (RLS) probing. Performed by the FCP
daemon, RLS probing reads the link error block from the device. This extended
link services command is defined by the FC standards. Refer to the FC standards
for information. RLS probing is enabled by default, meaning "Disable RLS
probing" is "off". "on" disables RLS probing.
Portlog Events Enable/Disable Settings
These settings determine whether or not various types of port events are logged.
Each event type displayed on the screen is enabled by default ("on"). When disabled, this event is not
logged by the port log.
Application Attributes
A number of application attributes are configurable. The following table specifies the attributes for
applications that can be modified.
Application Field
Type
Default
Range
_______________________________________________________________
ssl
Certificate File
string
[not-set] varies
CA Certificate File
string
[not-set] varies
Length of crypto key
number
[128]
40,56,128
rpcd
Secure RPCd Callback
Secret
string
none
varies
Webtools
Basic User Enabled
boolean
no
no/yes
Perform License
166
Fabric OS Command Reference
53-1003108-01
configure
Checking and Warning
Allow Fabric Event
Collection
Login Session Timeout
(in seconds)
NOTES
boolean
yes
yes/no
boolean
number
yes
200
yes/no
60 to
432000
2
The maximum per port login limit is no longer configurable with this command. Use the portcfgNPIVPort
--setloginlimit command to configure this parameter on a per port basis.
The Telnet interface is no longer configurable with this command. Use the ipFilter command to enable or
disable the Telnet interface.
The SNMP attributes are no longer configurable with this command. Use the snmpConfig --set seclevel
command to configure SNMP attributes.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable XISL use on a logical switch with FID 20:
switch:admin> setcontext 20
switch:admin> switchdisable
switch:admin> configure
Configure...
Fabric parameters (yes, y, no, n): [no] y
Domain: (1..239) [1]
Enable a 256 Area Limit
(0 = No,
1 = Zero Based Area Assignment,
2 = Port Based Area Assignment): (0..2) [0] 1
WWN Based persistent PID (yes, y, no, n): [no]
Allow XISL Use (yes, y, no, n): [yes]yes
R_A_TOV: (4000..120000) [10000]
E_D_TOV: (1000.. 5000) [2000]
WAN_TOV: (0..30000) [0]
MAX_HOPS: (7..19) [7]
Data field size: (256..2112) [2112]
Sequence Level Switching: (0..1) [0]
Disable Device Probing: (0..1) [0]
Suppress Class F Traffic: (0..1) [0]
Per-frame Route Priority: (0..1) [0]
Long Distance Fabric: (0..1) [0]
BB credit: (1..27) [16]
Disable FID Check (yes, y, no, n): [no]
Insistent Domain ID Mode (yes, y, no, n): [no]
Disable Default PortName (yes, y, no, n): [no]
Edge Hold Time(Low(80ms), Medium(220ms), High(500ms)
UserDefined(80-500ms): (80..500) [500]
Virtual Channel parameters (yes, y, no, n): [no]
F-Port login parameters (yes, y, no, n): [no]
Zoning Operation parameters (yes, y, no, n): [no]
RSCN Transmission Mode (yes, y, no, n): [no]
Arbitrated Loop parameters (yes, y, no, n): [no]
System services (yes, y, no, n): [no]
Fabric OS Command Reference
53-1003108-01
167
2
configure
Portlog events enable (yes, y, no, n): [no]
ssl attributes (yes, y, no, n): [no]
rpcd attributes (yes, y, no, n): [no]
webtools attributes (yes, y, no, n): [no]
switch:admin> switchenable
To enable Dynamic Area Mode on the default partition of the Brocade DCX:
switch:admin> switchdisable
switch:admin> configure
Configure...
Change fabric parameters? Y
Domain: (1..239) [160]
Enable 8 bit Dynamic Area Mode
(0 = No,
1 = Zero Based Area Assignment): (0..1) [0] 1
R_A_TOV: (4000..120000) [10000]
E_D_TOV: (1000..5000) [2000]
WAN_TOV: (0..30000) [0]
MAX_HOPS: (7..19) [7]
Data field size: (256..2112) [2112]
Sequence Level Switching: (0..1) [0]
Disable Device Probing: (0..1) [0]
Suppress Class F Traffic: (0..1) [0]
Per-frame Route Priority: (0..1) [0]
Long Distance Fabric: (0..1) [0]
BB credit: (1..27) [16]
Disable FID Check (yes, y, no, n): [no]
Insistent Domain ID Mode (yes, y, no, n): [no]
Disable Default PortName (yes, y, no, n): [no]
Edge Hold Time(Low(80ms), Medium(220ms), High(500ms),
UserDefined(80-500ms): (80..500) [500]
Virtual Channel parameters (yes, y, no, n): [no]
F-Port login parameters (yes, y, no, n): [no]
Zoning Operation parameters (yes, y, no, n): [no]
RSCN Transmission Mode (yes, y, no, n): [no]
Arbitrated Loop parameters (yes, y, no, n): [no]
System services (yes, y, no, n): [no]
Portlog events enable (yes, y, no, n): [no]
ssl attributes (yes, y, no, n): [no]
rpcd attributes (yes, y, no, n): [no]
cfgload attributes (yes, y, no, n): [no]
webtools attributes (yes, y, no, n): [no]
SEE ALSO
168
configDefault, configShow, configureChassis, ipAddrSet, portCfgLongDistance, switchDisable,
switchEnable, upTime
Fabric OS Command Reference
53-1003108-01
configureChassis
2
configureChassis
Changes chassis-level system configuration settings.
SYNOPSIS
DESCRIPTION
configurechassis
Use this command to modify chassis-level system configuration settings.
Configuration data is grouped into chassis information and switch information. Each configuration type is
managed separately.
Use the configure command to modify switch configuration parameters. Use the configureChassis
command to modify the following chassis configuration parameters:
•
•
•
•
Cfgload attributes
Custom Attributes
System settings
fos attributes
This command requires chassis permissions in both Virtual Fabric and non-Virtual Fabric environments.
The configureChassis command interactively presents a hierarchical menu. Each top-level heading
and its associated subheadings consist of a text prompt, a selection of valid values, and a default value
(in brackets).
The following keys control the execution of the command:
Return
When entered at a prompt with no preceding input, the command accepts the
default value (if applicable) and moves to the next prompt.
Interrupt (Ctrl-C)
Aborts the command immediately and ignores all changes made.
End-of-file (Ctrl-D)
When entered at a prompt with no preceding input, terminates the command and
saves changes made.
The following parameters can be modified with the configureChassis command:
Cfgload Attributes
Configures configuration upload and download parameters.
Enforce secure Config Upload/Download
Enables (yes) or disables (no) secure configuration upload or download. The
default value is "no.
Enforce signature validation for firmware
Enables (yes) or disables (no) signature validation enforcement. By default, this
feature is disabled (no).
Add Suffix to the uploaded file name
Appends a suffix to the uploaded configuration file. The suffix includes the chassis
name and a time stamp in the yyymmdd_hhmmss format. Refer to the example
section for an illustration. This feature is disabled by default.
Custom Attributes
The following custom attributes can be modified.
config Index
OEM custom configuration. The range is 0 through 10000. The default is 0. This
attribute is for internal use only.
Fabric OS Command Reference
53-1003108-01
169
2
configureChassis
System attributes
The following system-related parameters are configurable on a Virtual
Fabric-aware switch.
system.blade.bladeFaultOnHwErrMsk
If this field is set to a value other than 0, then any nonfatal HW ASIC data parity
error causes the problem blade to be powered off. The valid range is 0x0 to 0xffff.
The default value is 0x0.
system.cpuLoad
Sets a threshold to define internally when the CPU is busy. The default threshold
is 121, which represents a CPU instantaneous load average of 1.21 in the or top
command. The range is 10 to 121 (representing CPU load thresholds of .10 to
1.21).
system.i2cTurboCnfg
Configures the i2c driver that manages processing of the i2c interrupts. The I2C
Turbo mode is enabled (Setting 1) by default on all 16G platforms running Fabric
OS v7.0 or later. The mode is disabled by default for any switches capable of
running Fabric OS v6.4x and Fabric OS v6.3x. An upgrade preserves the
pre-upgrade configuration. The value shown in brackets is the current value. The
following values are supported:
0
Disables the I2C Turbo mode. When the I2C Turbo mode is disabled, every
byte received by an i2c interrupt is scheduled for processing by the given task
or process. This permits other high priority processes to complete, thereby
allowing for possible delay in the receipt of the I2C response message.
1
Enables the I2C Turbo mode for SFP transceivers only. This is the default
setting. When the I2C Turbo mode is enabled, every I2C byte received from
an SFP transceiver is processed by the interrupt handler itself, thus
preventing any higher priority processes from preempting this processing.
2
For internal use only.
fos attributes
The following chassis-wide CS_CTL mappings can be modified:
CSCTL QoS Mode
Configures the CS_CTL to virtual channel (VC) mapping. This operation is
disruptive and therefore you must disable all edge blades after you change the
CS_CTL to VC mapping.
0
Clears any previously configured CS_CTL to VC mapping and sets
one-to-one mapping between a CS_CTL value and VC number for Condor2
and Condor3 ASIC. The CS_CTL values are divided into three groups: 1-8
(low priority), 9-16 (medium priority), and 17-24 (high priority). This is the
default mode.
1
Sets the CS_CTL to VC mapping to support three CS_CTL values: 1 (low
priority), 2 (medium priority), and 3 (high priority). Each CS_CTL value can
map to more than one VC depending on the underlying support from ASIC.
This is the auto mode. For more information about CS_CTL-based frame
prioritization, refer to the Fabric OS Administrator's Guide.
170
Fabric OS Command Reference
53-1003108-01
configureChassis
NOTES
2
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable signature validation for downloading firmware:
switch:admin> configurechassis
Configure...
cfgload attributes (yes, y, no, n): [no] y
Enforce secure config Upload/Download (yes, y, no, n): [no]
Enforce signature validation for firmware (yes, y, no, n): [no]y
Add Suffix to the uploaded file name (yes, y, no, n): [no]
Custom attributes (yes, y, no, n): [no]
system attributes (yes, y, no, n): [no]
fos attributes (yes, y, no, n): [no]
To add a suffix to the uploaded file name:
switch:admin> configurechassis
Configure...
cfgload attributes (yes, y, no, n): [no] y
Enforce secure config Upload/Download (yes, y, no, n): [no]
Enforce signature validation for firmware (yes, y, no, n): [no]
Add Suffix to the uploaded file name (yes, y, no, n): [no] y
Custom attributes (yes, y, no, n): [no]
system attributes (yes, y, no, n): [no]
fos attributes (yes, y, no, n): [no]
To change the CS_CTL-based frame prioritization to default mode (one-to-one mapping):
switch:admin> configurechassis
Configure...
cfgload attributes (yes, y, no, n): [no]
Custom attributes (yes, y, no, n): [no]
system attributes (yes, y, no, n): [no]
fos attributes (yes, y, no, n): [no] y
CSCTL QoS Mode (0 = default; 1 = auto mode): (0..1) [1] 0
SEE ALSO
configDefault, configShow, chassisEnable, chassisDisable, configure, ipAddrSet,
portCfgLongDistance, switchDisable, switchEnable, upTime
Fabric OS Command Reference
53-1003108-01
171
2
creditRecovMode
creditRecovMode
Enables credit loss recovery on back-end ports and time-out based credit loss detection of Condor 2
front-end ports.
SYNOPSIS
creditrecovmode --cfg [off | onLrOnly | onLrThresh]
[-lrthreshold threshold]
-fault [edgeblade | coreblade | edgecoreblade]
creditrecovmode --check [slot/]blade_port,VC
creditrecovmode --fe_crdloss [off | on]
creditrecovmode --linkreset [slot/]blade_port
creditrecovmode --show
creditrecovmode --help
DESCRIPTION
Use this command to enable or disable credit recovery of backend ports and to display the configuration.
When this feature is enabled, credit is recovered on backend ports (ports connected to the core blade or
core blade backend ports) when credit loss has been detected on these ports. If complete loss of credit
on a Condor2 backend port causes frame timeouts, a link reset will be performed on that port regardless
of the configured setting, even if that setting is --cfg off. When used with the --cfg onLrOnly option, the
recovery mechanism takes the following escalating actions:
•
•
When it detects credit loss, it performs a link reset and logs a RASlog message (RAS Cx-1014).
•
•
If the port fails to reinitialize, the port is faulted. A RASlog message (RAS Cx-1016) is generated.
If the link reset fails to recover the port, the port reinitializes. A RASlog message is generated (RAS
Cx-1015). Note that the port reinitialization does not fault the blade.
If a port is faulted and there are no more online backend ports in the trunk, the core blade is faulted.
(Note that the port blade will always be faulted.) A RASlog message is generated (RAS Cx-1017).
When used with the --cfg onLrThresh option, recovery is attempted through repeated link resets and a
count of the link resets is kept. If the threshold of more than the configured threshold value (using the
-lrthreshold option) per hour is reached, the blade is faulted (RAS Cx-1018). Note that regardless of
whether the link reset occurs on the port blade or on the core blade, the port blade is always faulted.
If you suspect complete credit loss on a particular virtual channel (VC) on a particular backend port, use
the --check option to examine that particular backend port and VC for credit loss. If the command detects
complete credit loss, it reports the information. If, in addition, you have enabled link resets on backend
ports, this command will perform a link reset on the link in an attempt to recover from the problem. You
must explicitly initiate this check and it is a one-time operation. In other words, this command does not
continuously monitor for credit loss in the background. Detection of credit loss takes 2 to 7 seconds, after
which the results of the operation are displayed. A link reset also generates a RASlog message.
For more information on the RASlog messages, refer to the Fabric OS Message Reference.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command is supported only on backend ports of Condor, Condor 2, and Condor 3-based blades in
the Brocade DCX 8510-8 and DCX 8510-4 chassis.
The --check option is supported only on modular switches, and only on links between Condor 2 core
blades and Condor 2 port blades. AP blades are not supported.
172
Fabric OS Command Reference
53-1003108-01
creditRecovMode
2
The --fe_crdloss option is supported only on Condor 2-based front-end interswitch link (ISL) ports.
OPERANDS
This command has the following operands:
--cfg
Configures credit recovery for backend ports. Use one of the following required
recovery options to configure credit recovery:
onLrOnly
Enables the backend port recovery feature in link reset mode.
onLrThresh
Enables the backend port recovery feature in link reset threshold mode.
off
Disables the backend port credit recovery feature.
-lrthreshold threshold
Specifies the link reset threshold value. The default value is 2. Note that the
threshold value set using this option will apply only when the recovery mode is
onLrThresh.
-fault edgeblade
The edge blade alone is faulted when the link reset threshold is reached.
-fault coreblade
The core blade alone is faulted when the link reset threshold is reached.
-fault edgecoreblade
The edge blade is faulted the first two times the link reset threshold value is
reached. If the threshold value is reached the third time, the core blade is faulted.
The -fault option is supported only with the onLrThresh option.
--fe_crdloss
Configures time-out based credit loss detection of Condor 2 front-end ISL links.
This feature is enabled by default.
off
Disables credit loss detection on Condor 2 front-end ports.
on
Enables credit loss detection on Condor 2 front-end ports.
-check
Performs the on-demand detection of credit loss on a given backend port and VC.
This operand is optional and exclusive; when you specify this option you cannot
use the --cfg options at the same time. You must specify a port and a VC,
separated by a comma. A space before the comma is not permitted.
slot/blade_port
Specifies the backend port that is to be examined for credit loss. The port number
must be the blade port number, because this is a backend port. The blade port
number can be located in the "Bpt" column output of the bladePortMap
command. Note that the bladeportmap command requires root permissions.
VC
Specifies the Virtual Channel number. The valid range is from 1 through 31. VC 0
is invalid.
--linkreset slot/blade_port
Performs a link reset on the specified front-end or back-end blade port. The blade
port number can be located in the "Bpt" column output of the bladePortMap
command. The bladeportmap command requires root permissions.
Fabric OS Command Reference
53-1003108-01
173
2
creditRecovMode
--show
Displays the backend port credit recovery configuration as enabled or disabled. In
addition, the output indicates whether link reset mode or link reset threshold mode
is configured.
--help
Displays the command usage.
EXAMPLES
To enable backend port credit loss recovery with the link reset only option and to display the
configuration:
switch:admin> creditrecovmode --cfg onLrOnly
switch:admin> creditrecovmode --show
Internal port credit recovery is Enabled with LrOnly
C2 FE Complete Credit Loss Detection is Enabled
To enable backend port credit loss recovery with the link reset threshold option and to display the
configuration:
switch:admin> creditrecovmode --cfg onLrThresh
switch:admin> creditrecovmode --show
Internal port credit loss recovery is Enabled with LrThresh
C2 FE Complete Credit Loss Detection is Enabled
To disable backend port credit loss recovery and to display the configuration:
switch:admin> creditrecovmode --cfg off
switch:admin> creditrecovmode --show
Internal port credit loss recovery is Disabled
C2 FE Complete Credit Loss Detection is Enabled
To disable credit loss detection on Condor 2 front-end ports:
switch:admin> creditrecovmode --fe_crdloss off
switch:admin> creditrecovmode --show
Internal port credit loss recovery is Disabled
C2 FE Complete Credit Loss Detection is Disabled
To examine a backend port for credit loss:
switch:admin> creditrecovmode --cfg off
switch:admin> creditrecovmode --check 2/32,1
Started Credit loss Detection on slot 2 port 32 VC 1.
Please wait....
Detected credit loss.
Link Reset performed.
SEE ALSO
174
bottleneckMon
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
cryptoCfg
Performs encryption configuration and management functions.
SYNOPSIS
cryptocfg --help -nodecfg
cryptocfg --help -groupcfg
cryptocfg --help -hacluster
cryptocfg --help -devicecfg
cryptocfg --help -transcfg
cryptocfg --help -decommission
DESCRIPTION
Use the cryptoCfg command to configure and manage the Brocade Encryption Switch and the FS8-18
encryption blade. These platforms support the encryption of data-at-rest for tape devices and disk array
logical unit numbers (LUNs).
The cryptoCfg CLI consists of eight command sets grouped around the following configuration
functions:
1.
Node configuration
2.
Encryption group configuration
3.
High Availability (HA) cluster configuration
4.
Storage device configuration and management
5.
Transaction management
6.
Device decommissioning
Each of these command groups is documented in a separate section that includes function, synopsis,
description, and operands. Examples are presented at the end of the help page.
For detailed encryption switch management and configuration procedures, refer to the Fabric OS
Encryption Administrator's Guide.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
CAUTION: When configuring a LUN with multiple paths, there is a considerable risk of ending up
with potentially catastrophic scenarios where different policies exist for each path of the LUN, or
a situation where one path ends up being exposed through the encryption switch and other path
has direct access to the device from a host outside the secured realm of the encryption platform.
To protect against this risk, it is necessary to configure containers IN SEQUENCE and with the
same policies and not issue a commit until the configuration for all hosts accessing the LUN is
complete. Failure to follow correct configuration procedures for multi-path LUNs results in data
corruption. If you are configuring multi-path LUNs as part of an HA cluster or DEK cluster or as a
standalone LUN accessed by multiple hosts, follow the instructions described in the section
"Configuring a multi-path Crypto LUN" in the Fabric OS Encryption Administrator's Guide.
FUNCTION
1. Node configuration
SYNOPSIS
cryptocfg --help -nodecfg
Fabric OS Command Reference
53-1003108-01
175
2
cryptoCfg
cryptocfg --initnode
cryptocfg --initEE [slot]
cryptocfg --regEE [slot]
cryptocfg --enableEE [slot]
cryptocfg --disableEE [slot]
cryptocfg --export -scp -dhchallenge vault_IP_address |
-currentMK | -KACcert | -KACcsr | -CPcert
host_IP host_username host_file_path
cryptocfg --export -usb -dhchallenge vault_IP_address |
-currentMK | -KACcert | -KACcsr | -CPcert dest_filename
cryptocfg --import -scp local_name host_IP host_username
host_file_path
cryptocfg --import -usb dest_filename source_filename
cryptocfg --reg -membernode member_node_WWN
member_node_certfile Member_node_IP_addr
cryptocfg --dereg -membernode member_node_WWN
cryptocfg --dhchallenge vault_IP_addr
cryptocfg --dhresponse vault_IP_addr
cryptocfg --zeroizeEE [slot]
cryptocfg --delete -file local_name
cryptocfg --reg -KAClogin primary | secondary
cryptocfg --show -file -all
cryptocfg --show -localEE
cryptocfg --rebalance [slot]
cryptocfg --kvdiag [-enable | -disable | -show]
[-interval interval] [-type type]
DESCRIPTION
Use the node configuration commands to perform node initialization and configuration tasks. Node
initialization and configuration must be performed on every node. A node is an encryption switch or a
chassis containing one or more encryption blades. A node is identified by the switch IP address or switch
WWN, which is subsequently referred to as the "node WWN." The node configuration commands include
the following functions:
•
•
•
•
176
Node initialization and certificate generation.
Certificate export and import to and from a specified host or USB device.
Enabling or disabling an encryption engine (EE).
Encryption group member node and group leader registration.
Fabric OS Command Reference
53-1003108-01
cryptoCfg
•
•
•
•
•
•
2
Group-wide policy configuration.
Zeroization of all critical security parameters on the local encryption switch or blade.
Certificate display and management.
Display of the local encryption engine status.
Rebalancing of disk and tape LUNS for optimized performance.
Configuring and running key vault diagnostics.
Use the --show -localEE command to display encryption engine configuration parameters pertaining to
the local node. The command displays the following information:
•
•
•
•
•
•
EE Slot: Encryption engine slot number.
SP state: Security processor state. For a complete listing of SP states, refer to the Fabric OS
Encryption Administrator's Guide, Appendix A.
Current master key ID (or primary link key ID) - Key ID or zero if not configured.
Alternate master key ID (or secondary link key- Key ID or zero if not configured.
HA cluster name to which this EE belongs, or "No HA cluster membership".
EE Attributes: The following attributes are displayed:
-
Link IP Address: Link IP address
-
System Card Label: Displayed only if a system card is registered
Link GW IP Address: Link gateway W IP address
Link Net Mask: Link net mask
Link MAC Address: Link MAC address
Link MTU: The maximum transmission unit of the link
Link State: DOWN unless the EE is part of an HA cluster
Route Mode: Always "shared;" this parameter is not configurable
Media Type: TAPE, DISK, DISK/TAPE, or NOT DEFINED
Rebalance Recommended: No, Yes, or EE Busy (unspecified, try again to determine rebalance
recommendation)
System Card CID: Displayed only if a system card is registered.
Remote EE Reachability: If the EE is part of an encryption group, the following information is displayed
for the peer. Node WWN/Slot, EE IP Address, EE State, and IO Link State. On a chassis with multiple
encryption blades, remote reachability information is displayed for all encryption groups.
NOTES
OPERANDS
The initial setup includes preparatory steps that are outside the scope of the cryptoCfg command. For
preinitialization procedures, refer to the Fabric OS Encryption Administrator's Guide.
The cryptoCfg node initialization and configuration function has the following operands:
--help -nodecfg
Displays the synopsis for the node initialization and configuration function. This
command is valid on all nodes.
--initnode
Initializes the node to prepare for the configuration of encryption options.
Initialization must be performed on every node before configuration options may
be set and encryption may be enabled.
This command prompts for confirmation, because the --initnode function
overwrites any previously generated identification or authentication data on the
node. Successful execution generates the node CP certificate, the key
authentication center (KAC) certificate, the FIPS Crypto Officer, and the FIPS
User key pairs.
Fabric OS Command Reference
53-1003108-01
177
2
cryptoCfg
Some of the certificates generated with this command may need to be exported
so that they can be registered with external entities, such as the key vault or the
group leader, for mutual authentication. Refer to the Fabric OS Encryption
Administrator's Guide for details.
The --initnode function must be performed before the --initEE function may be
performed.
--initEE
Initializes the encryption engine (EE). This command generates critical security
parameters (CSPs) and certificates in the CryptoModule's security processor
(SP). The CP and the SP perform a certificate exchange to register respective
authorization data. Initialization must be performed on every encryption engine
before configuration options may be set and encryption may be enabled.
This command prompts for confirmation, because it overwrites any previously
generated identification or authentication data on the SP. Existing key encryption
keys (KEKs) such as link keys or master keys are erased. If this is not a first-time
initialization, make sure to export the master key before running this command. If
the encryption engine was configured with an LKM key vault, you will have to
reconfigure the key vault to regenerate the Trusted Link after initializing the
encryption engine.
The --initnode function must be performed before the --initEE function may be
performed.
slot
Specifies the slot number of the encryption engine to be initialized. This operand
is required on bladed systems.
--regEE
Registers a previously initialized encryption engine with the CP or chassis. The
CP and the specified encryption engine perform a certificate exchange to register
respective authorization lists across the encryption engine's FIPS boundary. The
encryption blade's certificate is registered with the CP. The CP, FIPS Crypto
Officer, and FIPS User certificate are registered with the specified encryption
engine.
slot
Specifies the slot number of the encryption engine to be registered. This operand
is required on bladed systems.
--enableEE | --disableEE
Enables or disables an encryption engine to perform encryption. You must create
the encryption group and complete the key vault registration before you can
enable an encryption engine for encryption. In addition, you must re-enable the
encryption engine for encryption every time a Brocade Encryption Switch or DCX
chassis goes through a power cycle event or after issuing slotPowerOff followed
by slotPowerOn for an FS8-18 blade. This command is valid on all nodes.
slot
Specifies the slot number to identify the encryption engine. This operand is
required on bladed systems.
178
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--export
Exports a certificate from the local encryption switch or blade to a specified
external host or to a mounted USB device. This command is valid on all nodes.
The files are exported from the predetermined directory that was generated during
the node initialization phase. The following operands are supported with the
--export command:
-scp
Exports a specified certificate to an external host using the secure copy (SCP)
protocol.
When -scp is specified, the following operands are required:
host IP| host_name
Specifies the IP address of the host to which the file is to be exported. To
specify the host by name, it must first be configured with the dnsConfig
command.
host_username
Specifies the user name for the host. Depending on your host configuration,
the command may prompt for a password.
host_file_path
Specifies the fully qualified path to the file on the host to which the file is to be
exported. This includes the file name. Make sure to name your certificates so
you can track the file type and the originator switch, for example,
name_cpcert.pem.
-usb
Exports a specified certificate to a mounted USB storage device. When -usb is
specified, the following operands are required:
dest_filename
Specifies the name of the file on the USB device to which the file is to be
exported. The file is stored in a predetermined default directory on the
storage device.
Specify one of the following certificates to be exported. Certificates must be
specified by file type. Referring to certificates by file name is not permitted. These
file types are valid both with the -scp and with the -usb options.
-dhchallenge vault_IP_address
Exports the DH Challenge file for the specified key vault.
-currentMK
Exports the current master key file.
-KACcert
Exports the KAC certificate.
-KACcsr
Exports the certificate sign request file. Use the cryptocfg --reg -KACcert
command to register the certificate on the node after it has been signed and
reimported. This procedure must be performed for all nodes that participate in
a two-way certificate exchange-based authentication mechanism with key
vaults. Two-way certificate exchange is supported only for the DPM, HP
SKM, and TEKA key vaults.
-CPcert
Exports the member node CP certificate.
--import
Imports a certificate from a specified external host or from a mounted USB
storage device to a predetermined directory on the local encryption switch or
blade. This command is valid on all nodes.
Fabric OS Command Reference
53-1003108-01
179
2
cryptoCfg
Files to be imported include member node CP certificates and key vault
certificates. Use the cryptocfg --show -file -all command to view all imported
files. The following operands are supported with the --importcommand:
-scp
Imports a specified certificate from an external host using the secure copy (SCP)
protocol. When -scp is specified, the following operands are required:
local_name
Specifies the name to be assigned to the imported certificate. This is a
user-generated file name.
host_IP | host_name
Specifies the IP address or name of the host from which to import the file. To
specify the host by name, it must first be configured with the dnscCnfig
command.
host_username
Specifies the user name for the host. Depending on your host configuration,
this command may prompt for a password.
host_file_path
Specifies the fully qualified path of the file to be imported. The path must
include the file name.
-usb
Imports a file from a mounted USB storage device. This command is valid only on
nodes with an attached USB device. When -usb is specified, the following
operands are required:
dest_filename
Specifies the name to be assigned to the imported file. This is a
user-generated file name.
source_filename
Specifies the name of the certificate on the USB storage device from which
you are importing.
--reg -membernode
Registers a member node with the group leader. This command is valid only on
the group leader. The encryption group must have been created prior to
performing member node registration. All member nodes and group leaders must
be registered before encryption group discovery and formation can occur.
The order in which member node registration is performed defines group leader
succession. At any given time, there is only one active group leader in an
encryption group. The group leader succession list Specifies the order in which
group leadership is assumed if the current group leader is not available.
The following operands are required when registering a member node with the
group leader:
member_node_WWN
Specifies the switch world wide name of the member node.
member_node_certfile
Specifies the member node CP certificate. You must have exported this file earlier
to external storage and then imported it to the group leader before you can
register a member node. Use the cryptocfg --show -file -all command to view all
imported certificates.
member_node_IP_add
Specifies the IP address of the member node to be registered with the group
leader.
180
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--dereg -membernode
Removes the registration for the specified member node. This command is valid
only on the group leader. The node is identified by the switch WWN.
member_node_WWN
Specifies the member node by its switch WWN. This operand is required when
removing a node registration.
--dhchallenge
Establishes a link key agreement protocol between a node and an instance of the
primary or backup NetApp Lifetime Key Management (LKM) appliance. This
command generates the Diffie-Hellman challenge that is passed from the node to
the specified NetApp LKM appliance. When quorum authentication is enabled and
the quorum size is greater than zero, this operation requires authentication of a
quorum of authentication cards. This command is valid on all nodes.
vault_IP_addr
Specifies the IP address of the NetApp LKM appliance. This operand is required.
--dhresponse
Accepts the LKM Diffie-Hellman response from the specified NetApp LKM
appliance and generates the link key on the node on which this command is
issued. The DH response occurs by an automatic trusted link establishment
method. The LKM appliance must be specified by its vault_IP_addr. The DH
challenge request must be approved on the Net App LKM appliance for this
command to succeed. When quorum authentication is enabled (Quorum Size is >
0), this operation requires authentication of a quorum of authentication cards.
vault_IP_addr
Specifies the IP address of the NetApp LKM appliance. This operand is required.
--zeroizeEE
Zeroizes all critical security parameters on the local encryption switch or blade
including all data encryption keys. This command is valid on all nodes. This
operation causes the encryption switch to reboot. When issued on a chassis, it
power-cycles the encryption blade only. This command prompts for confirmation
and should be exercised with caution.
slot
Specifies the slot number of the encryption engine to be zeroized on a bladed
system.
--delete -file
Deletes an imported file. The file must be specified by its local name. This
command is valid on all nodes.
local_name
Specifies the file to be deleted from the local directory where certificates are
stored.
--reg -KAClogin
Registers the node KAC login credentials (username and password) with the
configured key vaults. This command is valid for the Thales nCipher (TEKA), HP
SKM, and the TKLM key vaults. This command must be run on each member
node.
primary | secondary
Specifies the key vault as primary or secondary.
For the TEKA, run this command on both a primary and a secondary key vault.
The system generates a username based on the switch WWN. The username
and group under which the username should be created on the key vault are
displayed when the command is executed. Configure the password on the switch
and create the same username on the key vault.
Fabric OS Command Reference
53-1003108-01
181
2
cryptoCfg
For the SKM, run this command only for the primary key vault. The login
credential must match a valid username/password pair configured on the key
vault. The same username/password must be configured on all the nodes of
any given encryption group to prevent \ivity issues between the SKM and
the switch. However, there is no enforcement from the switch to ensure the
same username is configured on all nodes. Different encryption groups can
use different usernames so long as all nodes in the group have the same
username. Changing the username using -KAClogin renders the previously
created keys inaccessible. When changing the username you must do the same
on the key vault, and you must change the key owner for all keys of all LUNs
through the SKM GUI. For downgrade considerations, refer to the Fabric OS
Encryption Administrator's Guide.
--show
Displays node configuration information. This command requires one of the
following mutually exclusive operands:
-localEE
Displays encryption engine information local to the node.
-file -all
Displays all imported certificates. The -all parameter is required with the --show
-file command.
--rebalance [slot]
Rebalances the disk and tape containers to maximize throughput. Rebalancing is
recommended after containers have been added, removed, moved, failed over,
and failed back. This is a disruptive operation. You may have to restart backup
applications after rebalancing is complete. Optionally specify a slot number on
bladed systems.
--kvdiag -enable
Enables the keyvault diagnostics. When enabled, this command checks
connectivity, configuration parameter retrieval, and readiness for key retrieval and
archival at specified intervals. You can configure the tests to run separately for
each encryption node. The actions of this command are diagnostic only; no
corrective measures are taken. Key vault connectivity errors are reported through
RASlog messages. Logs are stored in /etc/fabos/mace/kvdiag.log. The key vault
diagnostics is by default enabled.
--kvdiag -disable
Disables the key vault diagnostics.
--kvdiag -show
Displays the current configuration of the key vault diagnostics, including the
enabled status, configured time interval, and test types.
--kvdiag -interval interval
Specifies the time interval at which the test is repeated (in minutes). Valid values
are 1 through 2147483647. The default value is 5 minutes. This operand is valid
only if key vault diagnostics is enabled.
--kvdiag -type type
Specifies the type of key vault test. Valid test types include the following:
connect
Monitors key vault connectivity. Disconnect and reconnect events generate a
RASlog message.
config
Retrieves configuration parameters from the key vault.
182
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
diag
Runs diagnostic tests including retrieval, archival and synchronization of the tests
in the key vault cluster.
EXAMPLES
To initialize a node and generate certificates (output shows what is generated and where it is stored):
SecurityAdmin:switch> cryptocfg --initnode
This will overwrite all identification and authentication data
ARE YOU SURE (yes, y, no, n): [no] y
Notify SPM of Node Cfg
Operation succeeded.
To initialize an encryption engine:
SecurityAdmin:switch> cryptocfg --initEE
This will overwrite previously generated identification
and authentication data
ARE YOU SURE (yes, y, no, n): y
Operation succeeded.
To register an encryption engine with the CP or chassis:
SecurityAdmin:switch> cryptocfg -regEE
Operation succeeded.
To enable an encryption engine:
SecurityAdmin:switch> cryptocfg --enableEE
Operation succeeded.
To disable an encryption engine:
SecurityAdmin:switch> cryptocfg --disableEE
Operation succeeded.
To export a KAC certificate from the group leader to an external host:
SecurityAdmin:switch> cryptocfg --export -scp -KACcert
192.168.38.245 mylogin kac_lkm_cert.pem
Password: ******
Operation succeeded.
\
To export a KAC certificate from the group leader to an attached USB device:
SecurityAdmin:switch> cryptocfg --export -usb
-KACcert kac_lkm_cert.pem
Password:******
Operation succeeded.
\
To import a member CP certificate to the group leader:
SecurityAdmin:switch> cryptocfg --import \
-scp enc1_cpcert.pem 192.168.38.245 mylogin
/temp/certs/enc_switch1_cpcert.pem
Password:
Fabric OS Command Reference
53-1003108-01
\
183
2
cryptoCfg
To register a member node with the group leader:
SecurityAdmin:switch> cryptocfg --reg \
-membernode 10:00:00:05:1e:39:14:00 \
enc_switch1_cert.pem 10.32.244.60
Operation succeeded.
To deregister a member node:
SecurityAdmin:switch> cryptocfg --dereg
-membernode 10:00:00:05:1e:53:b6:80
Operation succeeded.
\
To generate a trusted link establishment package (TEP):
SecurityAdmin:switch> cryptocfg --dhchallenge 10.33.54.231
Operation succeeded.
To issue the DH response to retrieve the TAP from the NetApp LKM appliance:
SecurityAdmin:switch> cryptocfg --dhresponse 10.33.54.231
Operation succeeded.
To zeroize all critical security parameters on an encryption switch:
SecurityAdmin:switch> cryptocfg --zeroizeEE
This will zeroize all critical security parameters
ARE YOU SURE (yes, y, no, n): [no]y
Operation succeeded.
To delete a file from the local node:
SecurityAdmin:switch> cryptocfg --delete -file \
/etc/fabos/certs/sw0/foo.pem
This will permanently delete the selected file.
ARE YOU SURE (yes, y, no, n): [no] y
To display local encryption engine information for a Brocade FS8-18 encryption blade on a DCX:
SecurityAdmin:switch> cryptocfg --show -localEE
EE Slot:
1
SP state:
Online
Primary Link KeyID: 85:1c:ca:dd:fc:8c:31:fc:87:21:26:d1:24:a0:92:be
Secondary Link KeyID:98:4f:b4:98:c0:42:ab:6b:6d:65:ba:f2:fc:aa:b5:8a
HA Cluster Membership:mace40_dcx74_1
EE Attributes:
Link IP Addr
: 10.32.72.75
Link GW IP Addr
: 10.32.64.1
Link Net Mask
: 255.255.240.0
Link MAC Addr
: 00:05:1e:53:8d:cd
Link MTU
: 1500
Link State
: UP
Media Type
: DISK/TAPE
Rebalance Recommended: NO
System Card Label :
System Card CID
:
Remote EE Reachability :
Node WWN/Slot
10:00:00:05:1e:54:22:36/0
10:00:00:05:1e:47:30:00/1
184
EE IP Addr
EE State IO Link State
10.32.72.62 EE_STATE_ONLINE Reachable
10.32.72.104 EE_STATE_ONLINE Reachable
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
10:00:00:05:1e:47:30:00/3 10.32.72.105 EE_STATE_ONLINE Reachable
10:00:00:05:1e:47:30:00/10 10.32.72.106 EE_STATE_ONLINE Reachable
10:00:00:05:1e:47:30:00/12 10.32.72.107 EE_STATE_ONLINE Reachable
EE Slot:
2
SP state:
Online
Primary Link KeyID: 85:1c:ca:dd:fc:8c:31:fc:87:21:26:d1:24:a0:92:be
Secondary Link KeyID:98:4f:b4:98:c0:42:ab:6b:6d:65:ba:f2:fc:aa:b5:8a
No HA cluster membership
EE Attributes:
Link IP Addr
: 10.32.72.76
Link GW IP Addr
: 10.32.64.1
Link Net Mask
: 255.255.240.0
Link MAC Addr
: 00:05:1e:53:89:03
Link MTU
: 1500
Link State
: UP
Media Type
: DISK
Rebalance Recommended: NO
System Card Label :
System Card CID
:
Remote EE Reachability :
Node WWN/Slot
10:00:00:05:1e:54:22:36/0
10:00:00:05:1e:47:30:00/1
10:00:00:05:1e:47:30:00/3
10:00:00:05:1e:47:30:00/10
10:00:00:05:1e:47:30:00/12
(output truncated)
EE IP Addr
10.32.72.62
10.32.72.104
10.32.72.105
10.32.72.106
10.32.72.107
EE State
IO Link State
EE_STATE_ONLINE Reachable
EE_STATE_ONLINE Reachable
EE_STATE_ONLINE Reachable
EE_STATE_ONLINE Reachable
EE_STATE_ONLINE Reachable
To rebalance load between tape and disk LUNS for optimal performance on slot 1:
switch:admin> cryptocfg --rebalance 1
Rebalancing the EE may cause disruption to disk I/Os.
Backup applications to tapes may need to be
restarted after rebalance.
ARE YOU SURE (yes, y, no, n): [no] yes
Operation succeeded
To disable the key vault diagnostics:
switch:admin> cryptocfg --kvdiag -disable
Key vault diagnostic periodic tests Disabled
Operation succeeded
To re-enable the key vault diagnostics after it has been disabled:
switch:admin> cryptocfg --kvdiag -enable
Key vault diagnostic periodic tests Enabled
Interval:
5 minute(s)
Test Type:
(diag) key retrieval/archival readiness
Operation succeeded
Fabric OS Command Reference
53-1003108-01
185
2
cryptoCfg
To display the key vault diagnostics configuration:
switch:admin> cryptocfg --kvdiag -show
Key vault diagnostic periodic tests Enabled
Interval:
5 minute(s)
Test Type:
(diag) key retrieval/archival readiness
Operation succeeded
To change the interval at which the key vault diagnostics is run:
switch:admin> cryptocfg --kvdiag -interval 60
Key vault diagnostic periodic tests Enabled
Interval:
60 minute(s)
Test Type:
(diag) key retrieval/archival readiness
Operation succeeded
FUNCTION
2. Encryption group configuration
SYNOPSIS
cryptocfg --help -groupcfg
cryptocfg --create -encgroup encryption_group_name
cryptocfg --delete -encgroup encryption_group_name
cryptocfg --reg -keyvault cert_label certfile hostname |
ip_address primary | secondary
cryptocfg --dereg -keyvault cert_label
cryptocfg --reg -KACcert signed_certfile primary | secondary
cryptocfg --set -keyvault LKM | DPM | SKM | TEKA | TKLM | KMIP
cryptocfg --set -kvparam ha transparent | opaque | disable
cryptocfg --set -kvparam login disable | enableU | enableP
cryptocfg --set -kvparam cert self | ca
cryptocfg --set -kvparam loglevel error | warning | info | io | debug | trace
cryptocfg --show -kvparam
cryptocfg --set -failbackmode auto | manual
cryptocfg --set -hbmisses value
cryptocfg --set -hbtimeout value
cryptocfg --set -quorumsize value
cryptocfg --set -systemcard enable | disable
cryptocfg --set -replication enable | disable
cryptocfg --add -membernode node_WWN
cryptocfg --eject -membernode node_WWN
186
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
cryptocfg --leave_encryption_group
cryptocfg --genmasterkey
cryptocfg --exportmasterkey [-file]
cryptocfg --recovermasterkey currentMK | alternateMK
-keyID keyID | -srcfile filename
cryptocfg --show -mkexported_keyids key_id
cryptocfg --show -groupcfg
cryptocfg --show -groupmember -all | node_WWN
cryptocfg --show -egstatus -cfg | -stat
cryptocfg --sync -encgroup
cryptocfg --sync -securitydb
cryptocfg --perfshow [slot] [-tx | -rx | -tx -rx] [-t interval]
DESCRIPTION
Use these cryptoCfg commands to create or delete an encryption group, to add or remove group
member nodes, key vaults, and authentication cards, to enable or disable system cards, to enable
quorum authentication and set the quorum size, to manage keys including key recovery from backup, to
configure group-wide policies, and to sync the encryption group databases.
An encryption group is a collection of encryption engines that share the same key vault and are managed
as a group. All EEs in a node are part of the same encryption group. An encryption group can include up
to four nodes, and each node can contain up to four encryption engines. The maximum number of EEs
per encryption group is sixteen (four per member node).
With the exception of the --help and --show commands, all group configuration functions must be
performed from the designated group leader. The encryption switch or blade on which you create the
encryption group becomes the designated group leader. The group leader distributes all relevant
configuration data to the member nodes in the encryption group.
The groupCfg commands include three display options that show group configuration, runtime status,
and group member information. Refer to the Appendix of the Fabric OS Encryption Administrator's Guide
for a more comprehensive explanation of system states.
Use the --show -groupcfg command to display encryption group and member configuration
parameters, including the following parameters:
•
•
Encryption group name: user-defined label
Encryption group policies:
•
Failback mode: Auto or Manual
Replication mode: Enabled or Disabled
Heartbeat misses: numeric value
Heartbeat timeout: value in seconds
Key Vault Type: LKM, DPM, SKM, TEKA, KMIP, or TKLM
System Card: Disabled or Enabled
For each configured key vault, primary and secondary, the command shows:
-
Fabric OS Command Reference
53-1003108-01
IP address: The key vault IP address
Certificate ID: the key vault certificate name
187
2
cryptoCfg
-
State: connected, disconnected, up, authentication failure, or unknown.
Type: LKM, DPM, SKM, TEKA, or TKLM
If an SKM key vault is configured in HA mode, no connection information is displayed because
the system is unable to detect the connection status of an SKM appliance in an HA
configuration.
•
Additional diagnostic key vault information to facilitate troubleshooting of connectivity "Additional
Primary Key Vault Information" and "Additional Secondary Key Vault Information" is displayed
separately. For the SKM and DPM there is just one section "Additional Key Vault/Cluster
Information"):
•
Server SDK Version: revision number or N/A
Node KAC Certificate Validity: Yes (valid) or No (invalid)
Time of Day on the Switch: time stamp
Client SDK Version: SDK revision number
Client Username: node login name for key vault
Client Usergroup: user group
Connection Timeout: time in seconds
Response Timeout: time in seconds
Connection Idle Timeout: time in seconds
Status message indicating success/readiness for key operations or, if there is a problem,
displays a diagnostic message. For example, if the username on the switch has changed, but
the key owner is still the old username, key operations will not be permitted.
Authentication Quorum Size: 0 (disabled), 1- 5 (enabled).
Authentication Cards: Certificate ID /label or "not configured".
Node list display includes the following parameters:
•
Time of Day on Key Server: time stamp or N/A
Quorum information includes the following parameters:
•
Port for Key Vault Connection: numeric identifier
Diagnostic information for the encryption node (key vault client):
•
Key Vault/CA Certificate Validity: Yes or No
Total number of defined nodes: numeric value
Group leader node name: Node WWN
Encryption group state: CONVERGED = Encryption group formed successfully. CONVERGING
= Encryption group partially formed, member nodes may still be in discovery process.
DEGRADED = Nodes lost connection with the group.
For each node in the encryption group, the following information is displayed:
-
Node name: the node WWN
IP address: the node IP address
Role: GroupLeader or MemberNode
Use the --show groupmember command to display encryption group member information for one or all
member nodes. Depending on the key vault configuration, the command displays master key information
(DPM) or link key information (LKM).
•
Node List (displayed only with the --all option)
-
188
Total number of defined nodes: numeric value
Group leader node name: the node WWN
Encryption group state: CONVERGED = Encryption group formed successfully. CONVERGING
= Encryption group partially formed, member nodes may still be in discovery process.
DEGRADED = Nodes lost connection with the group.
Fabric OS Command Reference
53-1003108-01
cryptoCfg
•
•
2
For each node, the display includes the following parameters:
-
Node Name: the node WWN
-
Role: GroupLeader or MemberNode
-
Current master key ID (or primary link key ID): Shows key ID or zero if not configured.
-
Alternate master key ID (or secondary link key ID): Shows key ID or zeroif not configured.
State: DISCOVERED = The node is part of the encryption group. DISCOVERING = The node is
in the process of discovery.
IP address: the node IP address
Certificate: the node CP certificate name (user-defined)
Current master key (or primary link key) state: Not configured, Saved, Created, Propagated,
Valid, or Invalid.
Alternate master key (or secondary link key) state: Not configured, Saved, Created,
Propagated, Valid, or Invalid.
For each encryption engine, the command displays the following parameters:
-
EE slot number: the encryption engine slot number
SP state: refer to the appendix in the Fabric OS Encryption Administrator's Guide. Current
master key ID (if DPM is configured) or primary link key ID (if LKM is configured).
Alternate master key ID (if DPM is configured) or secondary link keyID (if LKM is configured).
HA cluster name to which this encryption engine belongs, or "No HA cluster membership".
Media Type: DISK, TAPE, or MEDIA NOT DEFINED.
Use the --show -egstatus command with the -stat or -cfg option to display configuration or status
information for all nodes in the encryption group. This command displays a superset of information
included in the -groupcfg, -groupmember and -hacluster show commands. Refer to these commands
for a description of display details.
NOTES
All encryption engines in the encryption group must be interconnected through a dedicated local area
network (LAN), preferably on the same subnet and on the same VLAN using the GbE ports on the
encryption switch or blade. The two GbE ports of each member node (Eth0 and Eth1) should be
connected to the same IP Network, the same subnet, and the same VLAN. Configure the GbE ports (I/O
sync links) with an IP address for the eth0 Ethernet interface, and also configure a gateway for these I/O
sync links. Refer to the ipAddrSet help page for instructions on configuring the Ethernet interface.
These I/O sync link connections must be established before you enable the EEs for encryption. If these
configuration steps are not performed, you cannot create an HA cluster, perform a first-time encryption,
or initiate a rekeying session.
OPERANDS
The cryptoCfg group configuration function has the following operands:
--help -groupcfg
Displays the synopsis for the group configuration function. This command is valid
on all nodes.
--create -encgroup
Creates an encryption group. The node on which this command is invoked
becomes the group leader. You must specify a name when creating an encryption
group. If stale encryption configurations exist on the node, this command displays
a warning and prompts for confirmations to delete the configurations before
creating the encryption group. A "no" response aborts the operation.
encryption_group_name
Specifies the name of the encryption group to be created. The name can be up to
15 characters long and include alphanumeric characters and underscores. White
space, hyphens, and other special characters are not permitted.
Fabric OS Command Reference
53-1003108-01
189
2
cryptoCfg
--delete -encgroup
Deletes an encryption group with the specified name. This command is valid only
on the group leader. This command fails if the encryption group has more than
one node, or if any HA cluster configurations, CryptoTarget container/LUN
configurations, or tape pool configurations exist in the encryption group. Remove
excess member nodes and clear all HA cluster, CryptoTarget container/LUN, or
tape pool configurations before deleting an encryption group.
encryption_group_name
Specifies the name of the encryption group to be deleted. This operand is required
when deleting an encryption group.
--reg -keyvault
Registers the specified key vault (primary or secondary) with the encryption
engines of all nodes present in an encryption group. Upon successful registration,
a connection to the key vault is automatically established. This command is valid
only on the group leader. Registered certificates are distributed from the group
leader to all member nodes in the encryption group. Each node in the encryption
group distributes the certificates to their respective encryption engines.
The following operands are required when registering a key vault:
cert_label
Specifies the key vault certificate label. This is a user-generated name for the
specified key vault. Use the cryptocfg --show -groupcfg command to view the
key vault label after registration is complete.
certfile
Specifies the certificate file. This file must be imported prior to registering the key
vault and reside in the predetermined directory where certificates are stored. In
the case of the HP SKM, this operand specifies CA file, which is the certificate of
the signing authority on the SKM. Use the --show -file -all command for a listing
of imported certificates.
hostname | ip_address
Specifies the key vault by providing either a host name or IP address. If you are
registering a key vault that is part of an DPM cluster, the value for ip_address is
the virtual IP address for the DPM cluster and not the address of the actual key
vault.
primary | secondary
Specifies the key vault as either primary or secondary. The secondary key vault
serves as backup.
--dereg -keyvault
Removes the registration for a specified key vault. The key vault is identified by
specifying the certificate label. Removing a key vault registration disconnects the
key vault. This command is valid only on the group leader.
cert_label
Specifies the key vault certificate label. This operand is required when removing
the registration for a key vault.
--reg -KACcert
Registers the signed node certificate. After being exported and signed by the
external signing authority, the signed node certificate must be imported back into
the node and registered for a successful two-way certificate exchange with the
key vault. This command is valid only on the group leader.
Registration functions need to be invoked on all the nodes in a DEK cluster for
their respective signed node certificates. The following operands are required:
signed_certfile
Specifies the name of the signed node certificate to be reimported.
190
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
primary | secondary
Specifies the signing key vault as primary or secondary. This operand is valid only
with the TEKA, SKM, or KMIP key vault, which requires the CSR to be signed by
the primary or secondary vault. If both primary and secondary vaults are
configured, this command must be run once for the primary and once for
secondary key vault from every node.
--set -keyvault
Sets the key vault type. This command is valid only on the group leader.
value
Specifies the key vault type. The default is set to no value. This operand is
required. Valid values for -keyvault include the following parameters:
LKM
Specifies the NetApp LKM appliance (trusted key vault).
DPM
Specifies the Data protection Manager key repository.
SKM
Specifies one of the following: the HP Secure Key Manager (SKM) or the HP
Enterprise Secure Key Manager (ESKM). Both are opaque key repositories.
TEKA
Specifies the Thales e-Security keyAuthority (TEKA) key repository.
TKLM
Specifies the Tivoli Key Lifetime Manager (TKLM) key repository
KMIP
Specifies the Key Management Interoperability Protocol (KMIP) key
repository.
--set -kvparam
Sets the key vault configuration parameters. These parameters must be
configured after setting the key vault type to KMIP, and before the key vault is
registered on the Brocade Encryption Switch.
ha transparent | opaque | disable
Sets the HA mode for key archival.
login disable | enableU |enableP
Sets the user name and password authentication after TLS connection to a client
device is requested. If you specify "enableU", only a user name is required to
identify the client device. If you specify "enableP", both a user name and a
password are required to identify the client device.
cert self | ca
Specifies the certificate type to use for TLS connection.
loglevel warning | info | io | debug | trace
Changes the default logging level.
--show -kvparam
Displays all the configured KMIP key vault parameters.
--set -failbackmode
Sets the failback mode parameter. This parameter is set on the group leader. Valid
values for failback mode include the following parameters:
auto
Enables automatic failback. In this mode, failback occurs automatically within an
HA cluster when an encryption switch or blade that failed earlier has been
restored or replaced. Automatic failback mode is enabled by default.
Fabric OS Command Reference
53-1003108-01
191
2
cryptoCfg
manual
Enables manual failback. In this mode, failback must be initiated manually after an
encryption switch or blade that failed earlier has been restored or replaced.
--set -hbmisses
Sets the number of heartbeat misses allowed in a node that is part of an
encryption group before the node is declared unreachable. This value is set in
conjunction with the time-out value. It must be configured at the group leader node
and is distributed to all member nodes in the encryption group. The following
operand is required:
value
Specifies the number of heartbeat misses. The default value is 3. The range is 1
to 15 in integer increments only.
--set -hbtimeout
Sets the time-out value for the heartbeat. This parameter must be configured at
the group leader node and is distributed to all member nodes in the encryption
group. The following operand is required:
value
Specifies the heartbeat time-out in seconds. The default value is 2 seconds. Valid
values are integers in the range between 1 and 30 seconds.
--set -quorumsize
Sets the quorum size used to authenticate functions that require a quorum of
authentication cards. The default value is zero. You can set the quorum size only if
the current value is zero. Note that this value is different from the recovery set size
that specifies the number of recovery shares used to perform Master Key
recovery. When quorum authentication is enabled (Quorum Size is > 0), this
operation requires authentication of a quorum of authentication cards.
value
Specifies the quorum size. Valid values are 0 (quorum authentication is disabled)
and 1 through 5 (quorum authentication is enabled). This operand is required.
--set -systemcard> enable | disable
Enables or disables the system card usage policy. When the policy is enabled, a
system card is required to be inserted in an encryption engine to enable
encryption after a power-cycle event. When quorum authentication is enabled
(Quorum Size is > 0), this operation requires authentication of a quorum of
authentication cards. The policy is disabled by default. This command must be
executed on the group leader.
--set -replication enable | disable
Enables or disables replication-specific features. You must enable replication
before you can use replication-specific features such as the -newLUN,
-include_mirror, or the --refreshDEK command. Replication is disabled by
default; it must be enabled on the group leader. This command is supported only
for the DPM key vault.
--add -membernode
Adds the specified member node to the existing encryption group. The member
node is specified by its node WWN. This command is valid only on the group
leader. Initial setup on the node must be performed prior to adding the node to an
encryption group.
192
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
This command is required only when a node that was earlier part of encryption
group (online and DISCOVERED) was ejected or left the encryption group and is
now added back to that encryption group. A member node that is online during
registration is added automatically to the encryption group. The following operand
is required:
node_WWN
Specifies the WWN of the node to be added back to the encryption group.
--eject -membernode
Removes a member node from the existing encryption group. The node is
specified by its node WWN. This command is valid only on the group leader. The
node must be online (in DISCOVERED state) for this command to succeed. To
remove a node that is not online (in DISCOVERING State), use the --dereg
-membernode command. You must remove the EEs from the HA cluster and
delete any Crypto Target container/LUN configurations from this node before
ejecting the node or the command fails. The following operand is required when
ejecting a member node:
node_WWN
Specifies the node WWN of the node to be removed from the encryption group.
--leave_encryption_group
Clears the node's states pertaining to the node's membership in the encryption
group. This command is invoked from the member node that is to be ejected from
the encryption group.
If there are CryptoTarget container/LUN configurations on the node and the
encryption engines of this node are part of any HA Cluster configuration, this
command prompts you to either continue leaving the encryption group while
retaining the configuration, or to abort the leave operation. It is recommended that
you remove the EEs from the HA cluster and delete any CryptoTarget container
and Crypto LUN configurations from this node prior to initiating a leave operation.
--genmasterkey
Generates a master key. A master key is needed when an opaque key vault such
as DPM is used. The master key must be exported (backed up) before it may be
used. This command is valid only on the group leader. Only one master key per
key vault is needed for the entire encryption group. When a master key is
generated and a master key exists, the current master key becomes the alternate
master Key and the newly generated master key becomes the current master key.
--exportmasterkey
Exports the current master key encrypted in a key generated from a specified
pass phrase. By default this command backs up the key to the attached key
vaults, or optionally to a predetermined file on the switch. This command is valid
only on the group leader. This command prompts for a pass phrase.
passphrase
Specifies the pass phrase for the master key encryption. A pass phrase must be
between 8 and 40 characters in length and can contain any character
combination. Make a note of the pass phrase, because the same pass phrase is
required to restore the master key from backup. This operand is required.
-file
Stores the encrypted master key in a predetermined file on the switch. This
operand is optional. If the -file operand is not specified, the encrypted master key
is stored in the attached key vaults, using a unique associate Key ID for tracking
the export. Upon execution, this command displays both the associated Key ID
and the master key ID. You can export the master key to the key vault more than
Fabric OS Command Reference
53-1003108-01
193
2
cryptoCfg
once. Each time you export the same master key, the associate key ID is
incremented, and both the master key ID and the associate key are displayed.
Make a note of the key ID, because you will need same key ID is to restore the
master key from backup.
--recovermasterkey
Restores the master key from backup. This command is valid only on the group
leader. This command prompts for a pass phrase:
passphrase
Specifies the pass phrase for recovering the master key. The pass phrase must be
the same that was used to back up the master key with the --exportmasterkey
command.
currentMK | alternateMK
Specifies whether the master key should be restored to the current position or the
alternate position. This command replaces the specified existing master key and
should be exercised with caution. A master key is typically restored to the
alternate position to enable decryption of older data encryption keys (DEKs) that
were encrypted in that master key.
-keyID keyID
Specifies the associative master key ID. This option restores the master key from
the key vault. The associative master key ID was returned when it was backed up
to the key vault with the --exportmasterkey command. The -keyID and the
-srcfile options are mutually exclusive.
-srcfile filename
Specifies the file name when restoring the master key from a file in the
predetermined directory on the switch. Use this operand when the master key was
backed up to a file rather than to a key vault. The -keyID and the -srcfile
operands are mutually exclusive.
--show -mkexported_keyids key_id
Displays all exported key IDs used to store a particular master key on keyvault.
The key ID must be in the format displayed in the output of the cryptocfg --show
-localEE command. This command is valid on any node connected to the key
vault.
--show -groupcfg
Displays the group-wide encryption policy configuration. This command is valid on
all member nodes and on the group leader.
--show -groupmember
Displays detailed information for all encryption group members or for a single
member. This command is valid on all member nodes and on the group leader.
The following required operands are mutually exclusive:
-all
Displays information on all nodes in the existing encryption group.
node_WWN
Displays information on a single specified node. The node is identified by its node
WWN.
--show -egstatus
Displays encryption group configuration or status information for all nodes in the
encryption group. The following operands are exclusive:
-cfg
Displays encryption group configuration information.
-stat
Displays encryption group status information.
194
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--sync -encgroup
Manually synchronizes the encryption group database belonging to the group
leader node with the databases of all member nodes that are out of sync. If this
command is invoked when the encryption group databases are in sync, the
command is ignored.
Note: When the encryption group is out of sync and the group leader reboots, the
newly selected group leader pushes its database information to all other
members. The new group leader's database information may be different from
what was set up before the group leader was rebooted.
--sync -securitydb
Distributes the security database from the group leader node to all member
nodes. This operation can resolve problems with master key propagation. The
synchronization occurs every time this command is executed regardless of
whether or not the security database was in sync across all nodes in the
encryption group. This command is valid only on the group leader.
--perfshow
Displays the encryption performance.
slot
Displays the encryption performance for specified slot.
-tx
Displays the transmitter throughput.
-rx
Displays receiver throughput.
-tx -rx
Displays transmitter and receiver throughput.
-t interval
Specifies the time interval,in seconds, between refreshes.
EXAMPLES
To create an encryption group "brocade":
SecurityAdmin:switch> cryptocfg --create -encgroup brocade
Encryption group create status: Operation Succeeded.
To create an encryption group "brocade" on a node that has stale configurations:
SecurityAdmin:switch> cryptocfg --create -encgroup brocade
Warning: There are stale (Container|HA|Tape) cryptodb configurations.
Please confirm to delete them.
ARE YOU SURE (yes, y, no, n): [no] y
Warning: These are the list of crypto configuration \
to be cleaned up:
Inside /etc/fabos/mace (crypto_dek.db.0, crypto_dev.db.0, \
crypto_hac.db.0, crypto_pool.db.0, crypto_wwn.db.0).
ARE YOU SURE (yes, y, no, n): [yes]y
Encryption group create status: Operation Succeeded.
To delete the encryption group "brocade":
SecurityAdmin:switch> cryptocfg --delete -encgroup brocade
Encryption group create status: Operation Succeeded.
Fabric OS Command Reference
53-1003108-01
195
2
cryptoCfg
To register a NetApp LKM appliance as the primary key vault "LKM1":
SecurityAdmin:switch> cryptocfg --reg -regkeyvault \
LKM1 lkmcert.pem 10.33.54.231 primary decru-lkm-1
Register key vault status: Operation Succeeded.
To set the key vault type to KMIP:
SecurityAdmin:switch> cryptocfg --set -keyvault KMIP
Set key vault status: Operation Succeeded.
To set the key vault parameters:
SecurityAdmin:switch> cryptocfg--set -kvparam ha opaque
KVParams Set Successfully
SecurityAdmin:switch> cryptocfg--set -kvparam cert ca
KVParams Set Successfully
SecurityAdmin:switch> cryptocfg--set -kvparam login enableP
KVParams Set Successfully
To display the key vault parameter setting:
SecurityAdmin:switch> cryptocfg --show -kvparam
KVParams are:
HA Mode = HA Opaque
Username authentication = Username/password
Certificate signature = CA Signed
Key vault client logging level = None
To add a member node to the encryption group:
SecurityAdmin:switch> cryptocfg --add -membernode
10:00:00:05:1e:39:14:00
Add node status: Operation Succeeded.
\
To eject a member node from the encryption group:
SecurityAdmin:switch> cryptocfg --eject -membernode
10:00:00:05:1e:53:b8:45
Eject node status: Operation Succeeded.
\
To leave the encryption group:
SecurityAdmin:switch> cryptocfg --leave_encryption_group
Leave node status: Operation Succeeded.
To generate the master key (DPM) on the group leader:
SecurityAdmin:switch> cryptocfg --genmasterkey
Master key generated. The master key should be
exported before further operations are performed.
To export the master key to the DPM key vault:
SecurityAdmin:switch> cryptocfg --exportmasterkey
Enter passphrase: **********
Confirm passphrase:**********
Master key exported.
Master Key ID: 11:95:82:cd:80:88:41:31:42:dd:c3:5f:d0:a7:95:55
Exported Key ID: 11:95:82:cd:80:88:41:31:42:dd:c3:5f:d0:a7:95:56
Master key exported.
196
Fabric OS Command Reference
53-1003108-01
2
cryptoCfg
To export the master key to a file:
SecurityAdmin:switch> cryptocfg --exportmasterkey -file
Enter the passphrase: **********
Master key file generated.
To export the master key file to an external host:
SecurityAdmin:switch> cryptocfg --export -scp \
-currentMK 192.168.38.245 mylogin GL_MK.mk
Password:*************
Operation succeeded.
To recover the master key from the key vault to the current location:
SecurityAdmin:switch> cryptocfg --recovermasterkey currentMK -keyID
bd:ae:2d:0b:b9:1a:ad:18:0d:eb:fe:c9:67:ed:29:b0
Enter the passphrase: passphrase
Recover master key status: Operation succeeded.
\
To display the saved key IDs associated with a repeatedly exported master key
SecurityAdmin:switch> cryptocfg --show \
-mkexported_keyids e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:92
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:92
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:93
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:94
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:95
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:96
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:97
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:98
e3:ae:aa:89:ec:12:0c:04:29:61:9c:99:44:a3:9b:99
Operation Succeeded.
To display the encryption group configuration:
SecurityAdmin:switch> cryptocfg --show -groupcfg
Encryption Group Name: system_test
Failback mode:
Auto
Replication mode:
Disabled
Heartbeat misses:
3
Heartbeat timeout: 2
Key Vault Type:
LKM
System Card:
Disabled
Primary Key Vault:
IP address:
Certificate ID:
Certificate label:
State:
Type:
10.32.49.200
3D2-LKM3-B05-200
LKM200
Connected
LKM
Secondary Key Vault:
IP address:
Certificate ID:
Certificate label:
State:
Type:
10.32.49.201
3D2-LKM4-B05-201
LKM201
Connected
LKM
Additional Primary Key Vault Information::
Fabric OS Command Reference
53-1003108-01
197
2
cryptoCfg
Key Vault/CA Certificate Validity:
Port for Key Vault Connection:
Time of Day on Key Server:
Server SDK Version:
Yes
32579
N/A
N/A
Additional Secondary Key Vault Information:
Key Vault/CA Certificate Validity:
Yes
Port for Key Vault Connection:
32579
Time of Day on Key Server:
N/A
Server SDK Version:
N/A
Encryption Node (Key Vault Client) Information:
Node KAC Certificate Validity:
Yes
Time of Day on the Switch: Fri Jan 29 23:01:55.205779 GMT 2010
Client SDK Version:
OpenKey Reference Lib 2.0.9
Client Username:
N/A
Client Usergroup:
N/A
Connection Timeout:
20 seconds
Response Timeout:
20 seconds
Connection Idle Timeout:
N/A
Key Vault configuration and connectivity checks successful,
ready for key operations.
Authentication Quorum Size:
0
Authentication Cards not configured
NODE LIST
Total Number of defined nodes:
Group Leader Node Name:
Encryption Group state:
Node Name
10:00:00:05:1e:40:22:00
EE Slot:
SP state:
EE Slot:
SP state:
EE Slot:
SP state:
EE Slot:
SP state:
4
10:00:00:05:1e:54:22:36
CLUSTER_STATE_CONVERGED
IP address
10.32.72.74
1
Online
Role
MemberNode
2
Online
4
Online
9
Online
10:00:00:05:1e:53:6b:62 10.32.72.40 MemberNode(current node)
EE Slot:
0
SP state:
Waiting for enableEE
198
10:00:00:05:1e:54:22:36
EE Slot:
SP state:
10.32.72.61
GroupLeader
0
Online
10:00:00:05:1e:47:30:00
EE Slot:
SP state:
EE Slot:
SP state:
EE Slot:
SP state:
EE Slot:
SP state:
10.32.72.10 MemberNode
1
Online
3
Online
10
Online
12
Online
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
To display the encryption group member information:
SecurityAdmin:switch> cryptocfg --show -groupmember -all
NODE LIST
Total Number of defined nodes:2
Group Leader Node Name:
10:00:00:05:1e:41:9a:7e
Encryption Group state:
CLUSTER_STATE_CONVERGED
Node Name:
10:00:00:05:1e:41:9a:7e (current node)
State:
DEF_NODE_STATE_DISCOVERED
Role:
GroupLeader
IP Address:
10.32.244.71
Certificate:
GL_cpcert.pem
Current Master Key State: Not configured
Current Master KeyID: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
Alternate Master Key State:Not configured
Alternate Master KeyID:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
EE Slot: 0
SP state:
Operational; Need Valid KEK
Current Master KeyID: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
Alternate Master KeyID:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
No HA cluster membership
Node Name:
10:00:00:05:1e:39:14:00
State:
DEF_NODE_STATE_DISCOVERED
Role:
MemberNode
IP Address:
10.32.244.60
Certificate:
enc1_cpcert.pem
Current Master Key State: Not configured
Current Master KeyID:
00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
Alternate Master Key State:Not configured
Alternate Master KeyID: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
EE Slot: 0
SP state:
Unknown State
Current Master KeyID: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
Alternate Master KeyID:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
No HA cluster membership
No HA cluster membership
To set the failback mode to manual failback:
SecurityAdmin:switch> cryptocfg --set -failbackmode manual
Set failback policy status: Operation Succeeded.
To set the heartbeat miss value to 3:
SecurityAdmin:switch> cryptocfg --set -hbmisses 3
Set heartbeat miss status: Operation Succeeded.
To set the heartbeat timeout value to 10 seconds:
SecurityAdmin:switch> cryptocfg --set -hbtimeout 10
Set heartbeat timeout status: Operation Succeeded.
Fabric OS Command Reference
53-1003108-01
199
2
cryptoCfg
To display encryption performance:
SecurityAdmin:switch> cryptocfg --perfshow
33
32
38
39
37
36 34 35 43 42 41 40
==================================================================
5.4m
5.1m 5.4m 47.5m 0
0
0
0
0
0
0
0
47
46
44
45
55
54 52 53 51 50 48 49 Total
==================================================================
0
0
0
0
0
0
0
0
0
0
0
0 75.6m
FUNCTION
3. High Availability (HA) cluster configuration
SYNOPSIS
cryptocfg --help -hacluster
cryptocfg --create -hacluster HA_cluster_name
[node_WWN [slot]] [node_WWN [slot]]
cryptocfg --delete -hacluster HA_cluster_name
cryptocfg --delete -stale_dek node_WWN slot
cryptocfg --add -haclustermember HA_cluster_name
node_WWN [slot] [node_WWN [slot]]
cryptocfg --remove -haclustermember HA_cluster_name
node_WWN [slot] [node_WWN [slot]]
cryptocfg --replace [-haclustermember HA_cluster_name]
current_node_WWN [slot] new_node_WWN [slot]
cryptocfg --show -hacluster -all | HA_cluster_name
DESCRIPTION
Use these cryptoCfg commands to configure and manage High Availability (HA) clusters.
An HA cluster consists of two encryption engines configured to host the CryptoTargets and to provide the
active/standby failover and failback capabilities in a pair-wise relationship in a single fabric. The
encryption engines that are part of an HA cluster must belong to the same encryption group and be part
of the same fabric.
Failure to ensure that HA cluster members are part of the same encryption group dissolves the HA
cluster and the encryption engines lose their failover capability.
The HA cluster configuration must be performed on the group leader. Configuration changes must be
committed before they take effect. Use the cryptocfg --commit command to commit a new configuration
or a configuration change. Refer to section "5. Transaction management" for more information. Any
operation related to an HA cluster performed without a commit operation will not survive across switch
reboots, power cycles, CP failover, or HA reboots.
The command group includes a show option, --show -hacluster. When invoked on a member node, this
command displays the committed HA cluster configuration. When invoked on the group leader, both
defined and committed configuration data is displayed including the following parameters:
•
•
•
200
Encryption group name: A user-defined name
Number of HA clusters in the existing encryption group: numeric value
For each HA cluster:
Fabric OS Command Reference
53-1003108-01
cryptoCfg
•
HA cluster name: user-defined label
Number of encryption engine entries: numeric value
HA cluster Status: Committed or Defined
For each encryption engine member in the HA cluster:
OPERANDS
2
EE WWN: the encryption group world wide name
EE slot number: the encryption group slot number
EE status: online or offline
The cryptoCfg HA cluster configuration function has the following operands:
--help -hacluster
Displays the synopsis for the HA cluster configuration function. This command is
valid on all nodes.
--create -hacluster
Defines an HA cluster with a specified name and optionally associates up to two
encryption engines with the HA cluster. This command is valid only on the group
leader. The EEs must be members of the same encryption group as the group
leader on which this command is issued. This command fails if the member
nodes' IP addresses for the GbE ports (I/O sync ports) are not configured. The
encryption engines must belong to different switches or chassis. This rule is
enforced by the CLI to ensure redundancy.
The following operands are supported:
HA_cluster_name
Specifies the name for the HA cluster. The name can be up to 31 characters long
and can include alphanumeric characters, hyphens, and underscores. White
space and other special characters are not permitted. This operand is required.
node_WWN
Specifies the WWN of the switch or chassis to which the encryption engine
belongs. This operand is optional; if omitted, only the HA cluster name is defined.
You may add EEs separately with the --add -haclustermember command.
slot
Specifies the encryption engine slot number on bladed systems.
--delete -hacluster
Deletes the HA cluster with the specified name. This command is valid only on the
group leader. The following operand is required:
HA_cluster_name
Specifies the name of the HA cluster to be deleted.
--delete --stale_dek
Removes stale DEK entries belong to this EE. When BES/FS-18 is replaced with
another node in EG, leaves stale DEK entries that belong to replaced node in EG.
These stale entries should be removed from each node, otherwise DEK updates
on BP takes longer time as purging of these stale DEK entries happens. This
command needs to be run before replace command if stale DEK entries are seen.
It prints the number of EE entries on which stale DEK entries are present.
node_WWN
Specifies the node WWN of the switch or chassis on which the DEK entries are to
be removed.
slot
Specifies the encryption engine slot number on bladed systems.
Fabric OS Command Reference
53-1003108-01
201
2
cryptoCfg
--add -haclustermember
Adds one or more encryption engine members to an already configured HA. A
maximum of two HA cluster members is currently supported. The EEs must be
part of the same encryption group as the node on which this command is issued.
This command is valid only on the group leader. The encryption engines must
belong to different switches or chassis. This rule is enforced by the CLI to ensure
redundancy.
The following operands are required with the --add command:
node_WWN
Specifies the node WWN of the switch or chassis to which the encryption engine
belongs.
slot
Specifies the encryption engine slot number on bladed systems.
--remove -haclustermember
Removes one or both encryption engine members from an already configured HA
cluster. This command is valid only on the group leader. This command only
removes the failover/failback capability for the removed EEs; it does not affect the
relationship between configured CryptoTarget containers and the encryption
engine that is removed from the HA cluster. The containers still belong to this
encryption engine and encryption operations continue.
The following operands are required with the --remove command:
node_WWN
Specifies the WWN of the switch or chassis to which the encryption engine
belongs.
slot
Specifies the encryption engine slot number on bladed systems.
--replace -haclustermember
Replaces an encryption engine, either failed or alive, with an alternate encryption
engine. All target associations for the current encryption engine are transferred
over to the alternate encryption engine when this command is executed. The
alternate encryption engine does not have to be part of the current HA cluster.
Upon successful replacement, the alternate encryption engine automatically
becomes part of the configured HA cluster and disrupted peer relationships are
repaired. This command is only valid on the group leader.
The following operands are supported with the --replace command:
HA_cluster_name
Specifies the HA cluster member to be replaced. The HA cluster name must be
specified when this operand is used. This operand is optional. It is not needed if
the encryption engine to be replaced is not part of an HA cluster.
current_node_WWN [slot
Specifies the WWN of the encryption engine to be replaced. This operand is
required. On bladed systems, include the encryption engine slot number.
new_node_WWN [slot]
Specifies the WWN of the encryption engine that is to replace the current
encryption engine. This operand is required. On bladed systems, include the
encryption engine's slot number.
202
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--show -hacluster
Displays the specified HA clusters in the encryption group and associated state
information for all HA clusters or for a single, specified HA cluster. When invoked
on a member node, only the committed HA cluster configuration is displayed.
When invoked on the group leader, both defined and committed configuration data
is displayed.
The following operands are mutually exclusive:
-all
Displays configuration information for all HA clusters.
HA_cluster_name
Displays configuration information for a specified HA cluster.
EXAMPLES
To display existing HA clusters in the encryption group "brocade" (the encryption group in the example
has one committed HA cluster with one encryption engine):
SecurityAdmin:switch> cryptocfg --show -hacluster -all
Encryption Group Name: brocade
Number of HA Clusters: 1
HA cluster name: HAC1 - 1 EE entry
Status:
Committed
WWN
Slot Number
11:22:33:44:55:66:77:00
0
Status
Online
To create a second HA cluster with one encryption engine:
SecurityAdmin:switch> cryptocfg --create -hacluster HAC2
10:00:00:05:1e:53:4c:91
EE Node WWN: 10:00:00:05:1e:53:4c:91 Slot number: 0 Detected
Create HA cluster status: Operation succeeded.
To add another encryption engine to HA cluster HAC2:
SecurityAdmin:switch> cryptocfg --add -haclustermember HAC2
10:00:00:05:1e:53:74:87 3
EE Node WWN: 10:00:00:05:1e:53:74:87 Slot number: 3 Detected
Add HA cluster member status: Operation succeeded.
To display the changes (Note that "HAC2" is in the "defined" state until the transaction is committed):
SecurityAdmin:switch> cryptocfg --show -hacluster -all
Encryption Group Name: brocade_1
Number of HA Clusters: 2
HA cluster name: HAC1 - 1 EE entry
Status:
Committed
WWN
Slot Number
11:22:33:44:55:66:77:00
0
Status
Online
HA cluster name: HAC2 - 2 EE entries
Status:
Defined
WWN
Slot Number
10:00:00:05:1e:53:4c:91
0
10:00:00:05:1e:53:74:87
3
Status
Online
Online
Fabric OS Command Reference
53-1003108-01
203
2
cryptoCfg
To replace an encryption engine in HA cluster "HAC2":
SecurityAdmin:switch> cryptocfg --replace \
-haclustermember HAC2 10:00:00:05:1e:53:4c:91 \
10:00:00:05:1e:39:53:67
Replace HA cluster member status: Operation Succeeded.
To remove HA cluster member 10:00:00:05:1e:53:74:87 from the HA cluster "HAC2":
SecurityAdmin:switch> cryptocfg --rem -haclustermember
HAC2 10:00:00:05:1e:53:74:87
Remove HA cluster member status: Operation Succeeded.
\
To delete a previously created (committed) HA cluster named HAC1:
SecurityAdmin:switch> cryptocfg --delete -hacluster HAC1
Delete HA cluster status: Operation succeeded
To delete stale DEK entries:
SecurityAdmin:switch> cryptocfg --delete -stale_dek 10:00:00:05:1e:4b:54:00 3
Operation succeeded. 130 stale entries removed
To commit the changes:
SecurityAdmin:switch> cryptocfg --commit
Operation Succeeded
To view the changes:
SecurityAdmin:switch> cryptocfg --show -hacluster -all
Encryption Group Name: brocade_1
Number of HA Clusters: 1
HA cluster name: HAC2 - 1 EE entry
Status:
Defined
WWN
Slot Number
10:00:00:05:1e:39:53:67
0
Status
Online
To initiate a manual failback of an encryption engine:
SecurityAdmin:switch> cryptocfg --failback -EE
10:00:00:05:1e:39:53:67 0 22:00:00:04:cf:6e:57:62
Operation Succeeded
FUNCTION
4. Storage device configuration and management
SYNOPSIS
cryptocfg --help -devicecfg
cryptocfg --create -container disk | tape
crypto_target_container_name
EE_node_WWN [EE_slot] target_PWWN target_NWWN
[-initiator initiator_PWWN initiator_NWWN
[initiator_PWWN initiator_NWWN]...]
cryptocfg --delete -container crypto_target_container_name
cryptocfg --failback -EE current_node_WWN [current_slot]
new_node_WWN [new_slot]
cryptocfg --move -container crypto_target_container_name
204
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
new_node_WWN [new_slot]
cryptocfg --add -initiator crypto_target_container_name
initiator_PWWN initiator_NWWN
[[initiator_PWWN initiator_NWWN]...]
cryptocfg --remove -initiator crypto_target_container_name
initiator_PWWN [initiator_PWWN...]
cryptocfg --add -LUN crypto_target_container_name
LUN_Num | LUN_Num_Range
initiator_PWWN initiator_NWWN
[initiator_PWWN initiator_NWWN]...]
[-lunstate encrypted | cleartext]
[-keyID keyID]
[-encryption_format native | DF_compatible]
[-encrypt | -cleartext]
[-enable_encexistingdata | -disable_encexistingdata]
[-enablerekey time_period | -disable_rekey]
[-key_lifespan time_in_days | none]
[-newLUN]]
[-write_early_ack disable | enable]
[-read_ahead disable | enable]
cryptocfg --modify -LUN crypto_target_container_name
LUN_Num initiator_PWWN
[-encryption_format native | DF_compatible]
-encrypt | -cleartext]
[-enable_encexistingdata | -disable_encexistingdata]
[-enablerekey time_period | -disable_rekey]
[-write_early_ack disable | enable]
[-read_ahead disable | enable]
cryptocfg --remove -LUN crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --enable -LUN crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --create -tapepool -label pool_label | -num pool_num
[-encryption_format native | DF_compatible]
[-encrypt | -cleartext]
[-key_lifespan time_in_days | none]
cryptocfg --delete -tapepool
-label pool_label | -num pool_num
cryptocfg --modify -tapepool
-label pool_label | -num pool_num
[-encryption_format native | DF_compatible]
[-encrypt | -cleartext]
cryptocfg --manual_rekey crypto_target_container_name
LUN_Num initiator_PWWN [-include_mirror]
cryptocfg --manual_rekey -all [-include_mirror]
Fabric OS Command Reference
53-1003108-01
205
2
cryptoCfg
cryptocfg --resume_rekey crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --discoverLUN crypto_target_container_name
cryptocfg --show -container -all -cfg | -stat
cryptocfg --show -container crypto_target_container_name
-cfg | -stat
cryptocfg --show -tapepool -all | -label pool_label |
-num pool_num -cfg | -stat
cryptocfg --show -LUN crypto_target_container_name
LUN_Num initiator_PWWN -cfg | -stat
cryptocfg --show -rekey -all
cryptocfg --show -rekey crypto_target_container_name
cryptocfg --show -rekey crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --show -tape_sessions -all
cryptocfg --show -tape_sessions crypto_target_container_name
cryptocfg --clearstats -container
[-all | crypto_target_container_name ]
cryptocfg --clearstats -LUN crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --refreshDEK crypto_target_container_name
LUN_Num initiator_PWWN
cryptocfg --reclaimWWN -membernode node_WWN [-list]
cryptocfg --reclaimWWN -EE node_WWN slot[-list]
cryptocfg --reclaimWWN -cleanup
DESCRIPTION
Use these cryptoCfg commands to configure and manage tape or disk devices that store the encrypted
and compressed data.
A CryptoTarget container (CTC) is a configuration of "virtual devices" that is created for each target port
hosted on a Brocade Encryption Switch or FS8-18 blade. The container holds the configuration
information for a single target, including associated hosts and LUN settings. A CryptoTarget container
interfaces between the encryption engine, the external storage devices (targets), and the initiators
(hosts) that can access the storage devices through the target ports.
Virtual devices redirect the traffic between host and target/LUN to encryption engines so they can
perform cryptographic operations. To enable frame redirection, you must create a target-initiator zone
prior to performing any CryptoTarget container configuration.
The CryptoTarget container (CTC) and associated Crypto LUN configuration is always configured from
the group leader node, and the configuration is subsequentlyn propagated to all members in the
encryption group.
206
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
CTC configuration uses a transaction model. Configuration changes must be committed before they take
effect. Use the cryptocfg --commit command to commit the transaction. Refer to section "5. Transaction
management" for more information.
This command set supports the following tasks:
•
Configure and manage CryptoTarget containers (CTCs). Create, move, or delete a CTC, add or
remove initiators (hosts permitted to access the targets), or manually initiate a failback of an
encryption engine.
•
Configure and manage logical unit numbers (LUNs) for disk and tape storage devices: add a LUN to
a CTC, set or modify LUN encryption policy parameters, or remove a LUN from a CTC. Perform LUN
discovery.
•
Configure and manage tape pools: create a tape pool, set or modify tape pool encryption policies, or
delete a tape pool. Perform LUN discovery.
•
•
Manage rekey operations for primary and mirror LUNS.
Reallocate or change the world wide name (WWN) of virtual entities that have been moved or
removed from an encryption group. This operation is indicated when you want to eject a Brocade
Encryption Switch from an encryption group as a result of a move operation or a split EG, or if you
intend to remove an FS8-18 Encryption blade from an encryption group.
In addition, this command set includes the following display commands. Output may vary depending on
your configuration. Refer to the Appendix of the Fabric OS Encryption Administrator's Guide for a more
comprehensive explanation of system states.
Use the --show -container -all -stat command for runtime status information on all CryptoTarget
containers in the encryption group. The display includes the following information:
•
•
•
Encryption group name: user-define label
Number of containers numeric value
For each container:
-
Container name: user-defined label
-
LUN serial number: The LUN serial number
Fabric OS Command Reference
53-1003108-01
Type: disk or tape
EE node: The node WWN
EE slot: the slot number for the encryption engine
Target: The target port WWN
Target PID: The target PID
VT: The virtual target port WWN
VT PID: The virtual target PID
Number of hosts: numeric value
Number of tape sessions (or rekey sessions): numeric value
Host: The port WWN
Host PID: The host PID
VI: The virtual initiator port WWN
VI PID: The virtual initiator PID
Number of LUNs: numeric value
LUN number: numeric ID
LUN type: disk or tape drive, tape medium changer, tape attached medium changer, tape
offline/unknown, or unsupported/other
Encryption mode: encrypt or cleartext
Encryption format: (brocade) native or DF-compatible
Tape policy type: pool-based, LUN-based
207
2
cryptoCfg
-
Encrypt existing data: disabled or enabled
-
Encryption algorithm: AES256-ECB (DF_compatible), AES256-GCM (native) or None
(cleartext)
-
Key ID state: Read, Write, or Key ID not applicable
Rekey: disabled or enabled
Key life: the key life span (in days)
Volume/Pool label: the label for the tape volume or tape pool
Internal EE LUN state: Encrypted, Cleartext, or Disabled (Data state is cleartext but metadata
exists on the LUN, or vice versa.)
Key ID: The Key ID (if available)
New LUN: Yes or No
Replication LUN type: Primary or Mirror
Tape session number: numeric value
Number of uncompressed blocks: numeric value
Use the --show -container -all -cfg command for configuration information on all CryptoTarget
containers in the encryption group, or specify a crypto_target_container_name for information on a
specified CTC. The display includes the following information:
•
•
•
Encryption group name: user-defined label
Number of containers: numeric value
For each container
-
Container name: a user-defined label
Type: tape or disk
EE node: the node WWN
EE slot: numeric value
Target: target port WWN, node WWN
VT: virtual target port WWN, node WWN
Number of hosts: numeric value
Configuration status: committed or defined
For each host: the host port WWN and the node WWN
For each VI: the virtual initiator port WWN and the node WWN
Number of LUNs: numeric value
If a rekey session is in progress while the command is run, the following additional information is
displayed:
208
•
•
LUN number: numeric ID
•
•
•
•
•
•
•
•
•
•
LUN serial number (disk only): alpha-numeric ID
LUN type: disk, tape drive, tape medium changer, tape attached medium changer, offline/unknown,
or unsupported/other
Encryption mode: encrypt or cleartext
Encryption format: native or DF compatible
Encrypt existing data: enabled or disabled
Rekey: enabled or disabled
LUN state: refer to the appendix in the Fabric OS Encryption Administrator's Guide
Encryption algorithm: AES256 -XTS (disk), AES256-CCM (tape), or none
Key ID state: Rekey
Key ID: numeric identifier
Key creation time: date and time of key creation
Fabric OS Command Reference
53-1003108-01
cryptoCfg
•
•
•
•
•
•
•
•
•
•
2
Key life (in days); number of days until expiration
Rekey status: numeric value
Key expiration time
Rekey session number: numeric value
Percentage complete
Rekey state: Read or write Phase
Rekey role: primary, alternate
Block size: numeric value
Number of blocks: numeric value
Current logical block address (LBA) being processed
Use the --show -tapepool command to display tape pool configuration parameters for all Tape pools or
for a specific tape pool. For each tape pool, the display includes the following information:
•
•
•
•
•
tape pool Label: user-define label
Key Life: Life span in days
Encryption mode: encrypt or cleartext
Encryption format: native or DF compatible
Configuration status: committed or defined
Use the --show -LUN command for a listing of Crypto LUN status or configuration information for a
specific CTC.
When used with -stat the display includes the following LUN runtime status information:
•
•
•
•
•
•
•
•
•
•
•
Container name: user-defined label
Type: disk or tape
EE node: node WWN
EE slot: EE slot number
Target: target port WWN and node WWN
Target PID
VT: virtual target port WWN and node WWN
VT PID: virtual target PID
Number of hosts: numeric value
Number of rekey (or tape) sessions: numeric value
For each host:
•
•
Host PWWN, NWWN: host port WWN and node WWN
Host PID: host port ID
VI PWWN, NWWN: virtual initiator port WWN and node WWN
VI PID: virtual initiator port ID
Number of LUNs: numeric value
For each LUN:
-
LUN number: numeric value
-
LUN serial number: alpha-numeric ID
Fabric OS Command Reference
53-1003108-01
LUN type: disk, tape drive, tape medium changer, tape attached medium changer,
offline/unknown, or unsupported/other
Encryption mode: encrypt or cleartext
Encryption format: native or DF-compatible
Encrypt existing data: enabled or disabled
Rekey: enabled or disabled
209
2
cryptoCfg
-
Tape policy type: pool-based or LUN-based
Key life: key lifespan in days
Volume/pool label
LUN state: Refer to the Fabric OS Encryption Administrator's Guide.
Encryption algorithm: AES256 -XTS (disk), AES256-CCM (tape), or none
Compression algorithm
Key ID state: available or not available
Key ID: numeric identifier if available
New LUN: Yes or No
Replication LUN type: Primary or Mirror
If the LUN is a disk and the LUN is enabled for auto rekey, the following additional information is
displayed below the Key ID. Refer to the example section for an illustration.
-
Key creation time: date and time
Key life: remaining time (in days) until the key expires
Rekey status: 0 = rekey in progress, 1 = no rekey in progress
Key expiration time: date and time
Time remaining to Auto Rekey: Displays key life for LUNs that
are currently being rekeyed and after the rekey is complete.
The remaining Key life period is displayed in the following format: num_yrs, num_months,
num_days, num_minutes.
When used with -cfg the --show -LUN command displays LUN configuration information:
•
•
•
•
•
•
•
EE node: node WWN
EE slot: slot number
Target: target port WWN and node NWWN
VT: virtual target port WWN and node WWN
Number of hosts: numeric value
Configuration status: committed or defined
For each host:
•
•
210
Host port WWN and node WWN
Virtual initiator port WWN and node WWN
Virtual initiator PID
Number of LUNs
For each LUN:
-
LUN number: numeric identifier
-
LUN status: numeric value
LUN type: disk, tape drive, tape medium changer, tape attached medium changer,
offline/unknown, or unsupported/other
Encryption mode: encrypt or cleartext
Encryption format: native or DF compatible
Tape policy type: pool-based or LUN-based
Encrypt existing data: disabled or enabled
Rekey: disabled or enabled
Key ID state: Read, Write, or Key ID not applicable
Key life (in days): numeric value
Fabric OS Command Reference
53-1003108-01
cryptoCfg
-
2
Volume/pool label: user-defined label
Rekey status: numeric value
If rekey- or tape sessions are in progress, the command shows the following information:
•
•
Number of rekey sessions in progress: numeric value
For each rekey session the display includes the following parameters:
-
Rekey session number: numeric value
Percent completion: numeric value
Rekey state: Read or Write phase
Use the --show -rekey command to display all rekey sessions in progress on the current node or for a
specified container. The display includes the following information:
•
•
Number of rekey sessions in progress: numeric value
For each rekey session, the display includes the following parameters:
-
-
Container name: user-define label
EE node: node WWN
EE slot: Slot number
Target: target port WWN and node WWN
Target PID: target PID
VT: virtual target port WWN and node WWN
VT PID: virtual target PID
Host (initiator) PWWN
Host (initiator): node WWN
Host (initiator) PID: hoist PID
VI: virtual initiator port WWN and node WWN
VI PID: virtual initiator PID
LUN Number: numeric identifier
LUN Serial Number: alpha-numeric identifier
Percentage complete: numeric value
Rekey state displays one of the following parameters:

Read Phase

Write Phase

HA Sync Phase

LUN Cleanup
Rekey role: Primary or Backup
Block Size: in KB
Current logical block address (LBA) being processed: block address
Use the --show -rekey crypto_target_container_name LUN_Num initiator_PWWN command to display
all rekey sessions in progress for a specific Crypto LUN/initiator pair of a specific CryptoTarget container.
The display includes the following information:
•
•
•
•
•
•
•
LUN number: numeric ID
LUN Serial Number (SN): alpha-numeric label
CryptoTarget container Name: user-defined name
Target: target port WWN and node WWN
Target PID: target PID
EE node name: node WWN
EE slot: slot number
Fabric OS Command Reference
53-1003108-01
211
2
cryptoCfg
•
•
Number of rekey sessions in progress: numeric value
For each rekey session the display includes the following parameters:
-
-
-
Rekey session number: numeric value
Percent completion: numeric value
Rekey state. Displays one of the following parameters:

Rekey Setup

LUN Prep

Key Update
Operation in progress. Displays one of the following parameters:

Read Phase

Write Phase

HA Sync Phase

LUN Cleanup
VI: virtual initiator port WWN and node WWN
VI PID: virtual initiator PID
Number of blocks: numeric value
Block size: numeric value (in KB)
Size of the LUN (in bytes)
Current logical block address (LBA) being processed
Rekey Role: Primary Or Backup
Use the --show -tape_sessions command to display all tape sessions in progress on the local node or
for a specific container. The display includes the following information:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Number of tape sessions in progress: numeric value
Container name: user-defined label
EE node name: node WWN
EE Slot Number: slot number
Target: target port WWN and node WWN
Target PID: Target PID
VT: virtual target port WWN and node WWN
VT PID: virtual target PID
Host: host port WWN and node WWN
Host PID: host PID
VI: virtual initiator port WWN and node WWN
VI PID: virtual initiator PID
LUN number: numeric identifier
Tape session number: numeric identifier
For each Tape session:
-
212
Number of uncompressed blocks: numeric value
Number of compressed blocks: numeric value
Number of uncompressed bytes: numeric value
Number of compressed bytes: numeric value
Fabric OS Command Reference
53-1003108-01
cryptoCfg
NOTES
2
Encryption groups and HA clusters must be configured before performing any CryptoTarget container
and Crypto LUN configurations.
When adding a LUN to a CryptoTarget container, special attention should be paid to the input format. A
LUN number can be entered either as a 16-bit (2 bytes) number in hex notation (for example, 0x07) or as
a 64-bit (8 bytes) number in WWN format (for example, 00:07:00:00:00:00:00:00). Although the
command does accept decimal input, it is not recommended. The conversion function used to parse the
LUN number converts a decimal number beginning with 0 to an octal, which results in a conversion error.
For example, 035 is interpreted as 29 (decimal), or 0x1D hex, or 00:1D:00:00:00:00:00:00. To ensure
correct conversion to decimal notation, use the recommended Hex formats or make sure to remove
preceding zeros from decimal input.
OPERANDS
The cryptoCfg storage device configuration and management function has the following operands:
--help -devicecfg
Displays the synopsis for the storage device configuration and management
function. This command is valid on all nodes.
--create -container
Creates a CryptoTarget container (CTC) for a disk or a tape storage device. The
target device port WWN must be specified and one or more initiator port WWNs
(PWWNs) may optionally be specified. Additional initiator PWWNs may be added
after the CryptoTarget container is created.
Upon commit of a CTC configuration, one virtual target (VT) is created, and for
each initiator that has the access to the target port, one virtual initiator (VI) is
created. These virtual devices are created by logging into the fabric and
registering with the Name Server. Initiator and target must be zoned for NS-based
frame redirection to take effect. Use the nsShow command to verify the creation
of the virtual devices. Use the cfgShow command to view the redirection zone.
This command is valid only on the group leader. The following operands are
supported:
disk | tape
Specifies the type of the CTC as a disk array or tape storage container depending
on the target device. These operands are mutually exclusive.
crypto_target_container_name
Specifies the CTC name for the storage device. The CTC name can be up to 31
characters long and include any alphanumeric characters, hyphens, and
underscores. White space and other special characters are not permitted. This
operand is required.
EE_node_WWN [EE_slot
Specifies the WWN of the node to which the encryption engine belongs and on
which encryption engine this particular CTC is hosted. This operand is required.
On bladed systems, include the slot number.
target_PWWN
Specifies the target port WWN of the device port hosted on the encryption engine.
This operand is required.
target_NWWN
Specifies the target node WWN. This operand is required.
-initiator
Specifies one or more initiators. Specifying initiators within a CTC does not mean
that these initiators have access to the Crypto LUN. The initiator PWWNs still
need to be specified when the LUN is added to the CTC to which these initiators
should gain access. The initiators added to the CTC are used only for discovering
the LUNs of the target as exposed to these initiators.
Fabric OS Command Reference
53-1003108-01
213
2
cryptoCfg
This operand is optional. You may add initiators at the time when the CTC is
created or any time thereafter with the --add -initiator command. The following
operands are required when specifying an initiator:
initiator_PWWN
Specifies the initiator port WWN.
initiator_NWWN
Specifies the initiator node WWN.
--delete -container
Deletes a specified CTC. This command removes the virtual target and
associated LUNs from the fabric. Before issuing this command, you must stop all
traffic to the target port for which the CTC is being deleted. Failure to do so results
in I/O failure between the initiators and that target Port.
This command is valid only on the group leader. The following operand is required
when deleting a CTC:
crypto_target_container_name
Specifies the name of the CTC to be deleted. Use the cryptocfg --show
-container command for a listing of valid CTC names.
--failback -EE
Performs a manual failback of all CTCs that were failed over earlier to another
encryption engine within an HA cluster to a "new" specified encryption engine.
This command generates an error if the specified current encryption engine and
new encryption engine are not members of the same HA cluster or if the current
encryption engine or the new encryption engine are offline.
This command is valid only on the group leader. The following operands are
required:
current_node_WWN [current_slot]
Specifies the node WWN of the current encryption engine to which failover
occurred earlier, and which is now performing all encryption tasks. On bladed
systems, specify the slot number of the current encryption engine.
new_node_WWN [new_slot]
Specifies the node WWN of the encryption engine to which failback of all CTCs
should occur. On bladed systems, specify the slot number of the new encryption
engine.
--move -container
Moves the specified CTC from its currently configured encryption engine to
another encryption engine. This command is valid only on the group leader. The
EEs must be part of the same encryption group for this operation to succeed, but
they do not need to be part of the same HA cluster. This operation permanently
changes the encryption engine association of a single CTC from an existing
encryption engine to another encryption engine. To move all CTCs hosted on an
encryption engine permanently to another encryption engine, use the cryptocfg
--replace command.
This command is valid only on the group leader. The following operands are
required when moving a CTC:
crypto_target_container_name
Specifies the name of the CTC to be moved.
new_node_WWN [new_slot]
Specifies the encryption engine to which the CTC should be moved. On bladed
systems, specify the encryption engine's slot number.
214
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--add -initiator
Adds one or more initiators to an existing CTC. An initiator that is added to a CTC
facilitates discovering the LUNs of the target as exposed to these initiators. You
must still add the initiators when you add the LUN to the CTC to enable access for
these initiators.
This command is valid only on the group leader. The following operands are
required when adding an initiator to a CTC:
crypto_target_container_name
Specifies the name of the CTC to which the initiators should be added.
initiator_PWWN
Specifies the initiator port WWN.
initiator_NWWN
Specifies the initiator node WWN.
--remove -initiator
Removes an initiator from the specified CTC. This command is valid only on the
group leader. The following operands are required when removing anm initiator:
crypto_target_container_name
Specifies the name of the CTC from which the initiator is to be removed.
initiator_PWWN
Specifies the initiator port WWN.
--add -LUN
Adds a LUN to a CTC and optionally sets encryption policies for the LUN. The
maximum number of Tape LUNs that can be added to an Initiator in a container is
8. LUN policies may be set at this time or after the LUN is added. The maximum
number of LUNs you can add in one commit operation is 25. There is a delay of
five seconds for each commit operation.
This command is valid only on the group leader. The following operands are
supported:
crypto_target_container_name
Specifies the name of the CTC to which the LUN is added. This operand is
required.
LUN_Num | LUN_Num_Range
Specifies the LUN number or a range of LUN numbers. These operands are
mutually exclusive. The LUN number can be either a 16-bit (2 bytes) number in
hex notation (for example, 0x07) or a 64-bit (8 bytes) number in WWN format (for
example, 00:07:00:00:00:00:00:00). When specifying a range, the LUN numbers
must be 16-bit numbers in hex format. The Range parameter is not supported for
64-bit LUN numbers.
The LUN number must be zero when a tape LUN is specified and the tape drive is
a single LUN device.
initiator_PWWN initiator_NWWN
Optionally specifies one or more hosts (initiators) that will be permitted to access
the LUN. For each initiator added, the port WWN and the node WWN must be
specified. You may add more than one initiator.
Encryption policy parameters: The following encryption policy configuration
parameters can be optionally set for disk and tape devices when adding a LUN to
a CTC, or they can be set at a later time with the --modify -LUN command.
The tape policies specified at the LUN level take effect if you do not create tape
pools or configure policies at the tape pool level.
Fabric OS Command Reference
53-1003108-01
215
2
cryptoCfg
LUN policies are configured per HA or DEK cluster. For multi-path LUNs exposed
through multiple target ports and thus configured on multiple CTCs on different
EEs in an HA cluster or DEK cluster, the same LUN policies must be configured.
Refer to the Fabric OS Administrator's Guide for more information.
The following LUN policy parameters can be optionally set:
-lunstate encrypted | cleartext
Sets the encryption state of a specified disk LUN. When set to encrypted,
metadata on the LUN containing the key ID of the DEK that was used for
encrypting the LUN is used to retrieve the DEK from the key vault. If the LUN state
is not specified, the default state is cleartext. This operand is not valid for tape
LUNs.
-keyID keyID
Specifies the Key ID. Use this operand only if the LUN was encrypted but does not
include the metadata containing the keyID for the LUN. This is a rare case for
LUNS encrypted in Brocade native mode. However for LUNS encrypted with
DataFort v2.0, a Key ID is required, because these LUNs do not contain any
metadata. This operand is not valid for tape LUNs.
-encryption_format native | DF_compatible
Specifies the LUN encryption format. Two encryption formats are supported:
native
The LUN uses the Brocade metadata format and algorithm for the encryption
and decryption of data. This is the default mode.
DF_compatible
The LUN uses the NetApp DataFort metadata format and algorithm for the
encryption and decryption of data. Use of this format requires a NetApp
DataFort-compatible license to be present on the encryption switch or the
chassis that houses the encryption blade.
-encrypt | -cleartext
Enables or disables the LUN for encryption. By default, cleartext is enabled (no
encryption). When the LUN policy is changed from encrypt to cleartext, the
following policy parameters become disabled (default) and generate errors when
executed: -enable_encexistingdata, -enable_rekey, and -key_lifespan. When
a LUN is added in DF-compatible encryption format, -cleartext is rejected as
invalid.
-enable_encexistingdata | -disable_encexistingdata
Specifies whether or not existing data should be encrypted. The Encryption policy
must be enabled on the LUN before the -enable_encexistingdata parameter can
be set and the LUN state must be set to -cleartext. By default, encryption of
existing data is disabled. If LUN policy is set to -encrypt, the encryption of existing
data must be enabled, or existing data is not preserved. This policy is not valid for
tape LUNs.
-enable_rekey time_period | -disable_rekey
Enables or disables the auto rekeying capability on the specified disk LUN. This
operand is not valid for tape LUNs. By default, the automatic rekey feature is
disabled. Enabling automatic rekeying is valid only if the LUN policy is set to
encrypt. You must specify a time_period in days when enabling auto rekeying to
indicate the interval at which automatic rekeying should take place.
-key_lifespan time_in_days | none
Specifies the lifespan of the encryption key in days. The key will expire after the
specified number of days. Accepted values are integers from 1 to 2982616. The
default value is none, which means, the key does not expire. This operand is valid
only for tape LUNs. The key lifespan cannot be modified after it is set.
216
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
-newLUN
Indicates that the LUN created does not contain any user data and will be part of a
replication configuration. This operand is optional. The presence of this operand is
incompatible with the -keyID, -key_lifespan, and -enable_rekey options. An RSA
DPM must be configured and replication must be enabled (cryptocfg --set
replication enabled) before invoking this command. Both primary and remote
mirror LUNs must be added to their container with the -newLUN option.
-write_early_ack disable | enable
Specifies the Tape Write pipelining mode of the LUN. This option enables or
disables early acknowledgement of commands (internal buffering) for a tape LUN.
This feature is enabled by default.
-read_ahead disable | enable
Specifies the Tape Read Ahead mode of the LUN. When Tape Read Ahead is
disabled, the tape LUN operates in unbuffered mode. When Tape Read ahead is
disabled, the tape LUN operates in buffered mode. This feature is enabled by
default.
--modify -LUN
Modifies the encryption policies of one or more LUNs in a specified CTC. This
command is valid only on the group leader. The following operands are required
when modifying a LUN:
crypto_target_container_name
Specifies the name of the CTC to which the LUNs belong.
LUN_Num | range
Specifies the LUN number either as a 16-bit (2 bytes) number in hex notation (for
example, 0x07) or as a 64-bit (8 bytes) number in WWN format (for example,
0:07:00:00:00:00:00:00). The LUN number must be zero when a tape LUN is
specified and the tape drive is a single LUN device. When specifying a range, the
LUN numbers must be entered in the 16-bit hex format.
initiator_PWWN initiator_NWWN
Specifies the initiator by its port WWN and node WWN.
You may optionally modify the following LUN policy configuration parameters.
Refer to cryptocfg --add -LUN for descriptions of these parameters.
•
•
•
•
•
•
[-encryption_format native | DF_compatible]
[-encrypt | cleartext]
[-enable_encexistingdata | -disable_encexistingdata]
[-enablerekey time_period | -disable_rekey]
[-write_early_ack disable | enable]
[-read_ahead disable | enable]
Make sure you understand the ramifications of modifying LUN parameters (such
as changing the LUN policy from encrypt to cleartext) for devices that are online
and are already being utilized. The following restrictions apply when modifying
LUN policy parameters:
•
•
•
Fabric OS Command Reference
53-1003108-01
When you change LUN policy from encrypt to cleartext the following policy
parameters are restored to default (disabled): -enable_encexistingdata,
-enable_rekey, and -key_lifespan.
When changing the LUN policy back to encrypt, these parameters need to be
reconfigured. Attempting to reconfigure these parameters while the LUN
policy is set to cleartext is not permitted and generates an error.
For tape LUNs the -enable_encexistingdata and the -enable_rekey
operands are not valid and return an error when executed.
217
2
cryptoCfg
•
•
The -key_lifespan parameter cannot be modified for tape LUNs once it has
been set.
Exercise caution when modifying policy parameters while tape sessions are
in progress. For information on the impact of encryption policy changes while
tape sessions are in progress, refer to the Fabric OS Encryption
Administrator's Guide.
--remove -LUN
Removes a LUN from a specified CTC. You must stop all traffic to the LUN from all
initiators accessing the LUN you are removing from the CTC. Failure to do so
results in I/O failure between the initiators and the LUN. If the LUN is exposed with
different LUN Numbers to different initiators, all exposed LUN Numbers must be
removed. This command is valid only on the group leader. The following operands
are required when removing a LUN from a CTC:
crypto_target_container_name
Specifies the name of the CTC from which the LUN is to be removed.
LUN_Num
Specifies the number of the LUN to be removed. Use the --show -container
command for a list of LUN numbers associated with the specified CTC.
initiator_PWWN
Specifies the initiator port WWN for the LUN to be removed.
--enable -LUN
Forces the LUN to become enabled for encryption from a disabled state. This
command must be executed on the local switch that is hosting the LUN. No
commit is required after executing this command. This command proceeds with a
warning and prompts for confirmation.
A LUN may become disabled for various reasons, such as a change in policy from
encrypted to cleartext, a conflict between LUN policy and LUN, or a missing DEK
in the key vault. Force-enabling a LUN while metadata exist on the LUN may
result in a loss of data and should be exercised with caution. Refer to the Fabric
OS Encryption Administrator's Guide for a description of conditions under which a
LUN may be disabled and recommendations for re-enabling the LUN while
minimizing the risk of data loss.
The following operands are required when force-enabling a LUN:
crypto_target_container_name
Specifies the name of the CTC to which this LUN belongs.
LUN_Num
Specifies the number of the LUN to be enabled. Use the --show -container
command for a list of LUN numbers associated with the specified CTC.
initiator_PWWN
Specifies the initiator port WWN for the specified LUN.
--create -tapepool
Creates a tape pool. A tape pool consists of a group of tape media that share the
same encryption policies and data encryption keys (DEKs).
A maximum of 4096 tape pools per encryption group are supported. You may add
up to a maximum of 25 tape pools per commit operation. There is a delay of five
seconds delay at each commit operation.
Policy configuration at the tape pool level is optional; if left unspecified LUN-level
tape policy parameters apply.
218
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
This command is valid only on the group leader. The following operands are
supported:
-label pool_label | -num pool_num
Specifies the tape pool volume label or alternately the tape pool ID. This is a
user-defined identifier, which must be unique within the encryption group and
should match the tape pool label or ID that is configured on the tape backup
application. The tape pool label can consist of any combination of characters.
When using white space, you must enclose the tape pool label in double quotation
marks. The maximum size is 64 bytes. This operand is required.
-encryption_format
Optionally specifies the tape encryption format. Two encryption formats are
supported for tape pools:
native
Data is encrypted or decrypted using the Brocade native encryption format
(metadata format and algorithm). This is the default setting.
DF_compatible
Data is encrypted or decrypted using the NetApp DataFort encryption format
(metadata format and algorithm). Use of this format requires a NetApp
DataFort-compatible license on the encryption switch or on the chassis that
houses the encryption blade.
-encrypt | -cleartext
Enables encryption or cleartext (no encryption). By default, cleartext is enabled.
-key_lifespan time_in_days | none
Specifies the lifespan of the encryption key in days. The key expires after the
specified number of days. The default value is none, which means the key does
not expire until the value is set. This parameter cannot be modified for tape pools
once it is set.
--delete -tapepool
Deletes the specified tape pool. This command is valid only on the group leader.
The following operand is required:
-label pool_label | -num pool_num
Specifies the tape pool by volume label or tape pool ID. Use the --show -tapepool
command for a listing of configured tape pools and their respective labels or IDs.
--modify -tapepool
Modifies the encryption policies of a specified tape pool. This command is valid
only on the group leader. The following operand is required:
-label pool_label | -num pool_num
Specifies the tape pool by volume label or tape pool ID. Use the --show -tapepool
command for a listing of configured tape pools and their respective labels or IDs.
To modify the label or pool number, you must delete and recreate the tape pool.
You may optionally modify the following tape policy parameters.
•
•
[-encryption_format native | DF_compatible]
[-encrypt | cleartext]
Refer to cryptocfg --create -tapepool for descriptions of these parameters.
Exercise caution when modifying tape pool policy parameters while tape sessions
are in progress. Refer to the Fabric OS Encryption Administrator's Guide for more
information.
Fabric OS Command Reference
53-1003108-01
219
2
cryptoCfg
--manual_rekey
Performs a manual rekeying of a specified LUN associated with a specified CTC.
Manual rekeying is performed in both online and offline fashion depending on
whether or not the host is online or host I/O is present. If any policy-based
rekeying operation is currently in progress, this command aborts with a warning
message. This command is valid only on the group leader.
The following operands are supported:
crypto_target_container_name
Specifies the name of the CTC to which this LUN belongs.
LUN_Num
Specifies the number of the LUN to be rekeyed. Use the --show -container
command for a list of LUN numbers associated with the specified CTC.
initiator_PWWN
Specifies the port WWN of the initiator for the specified LUN.
-include_mirror
Initiates a manual rekey on mirror LUN or on a primary LUN in read-only state.
This operand is required if the specified LUN is mirror LUN or a primary that has
been restored from an out-of-sync mirror LUN.
-all
Performs a manual rekey operation on all encrypted primary or nonreplicated
LUNs on the node that are in read-write state. This operation may take an
extended period of time.
-include_mirror
Initiates a manual rekey operation on all primary LUNs and mirror LUNs in
read-only state. In addition, this command also starts a manual rekey operation on
all primary and nonreplicated LUNs in read-write state.
--resume_rekey
Resumes a suspended rekey session for a specified disk LUN at the termination
point. A rekey session may terminate prematurely due to unrecoverable medium
or hardware errors. When a rekey session terminates prematurely, the system
logs CRITICAL RASlog and rekey operation failure status messages. You must
take corrective action to clear all error conditions that caused the rekey failure
before resuming a suspended rekey session. All DEK or HA cluster members
must be online and reachable for this operation to succeed.
crypto_target_container_name
Specifies the name of the CTC to which the LUN belongs.
LUN_Num
Specifies the number of the LUN to be rekeyed. Use the --show -container
command for a list of LUN numbers associated with the specified CTC.
initiator_PWWN
Specifies the initiator port WWN for the specified LUN.
--discoverLUN
Performs LUN discovery. This command discovers and displays all LUNs that are
discoverable by the initiators of a specified CTC. This command is valid only on
the node that hosts the CTC. The following operand is required:
crypto_target_container_name
Specifies the name of the CTC.
220
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
--show -container
Displays all CTCs in the encryption group. This command is valid on all nodes.
The following operands are supported:
-all -cfg
Displays the configuration for all containers in the encryption group.
-all -stat
Displays the runtime status for all containers hosted on the local node only.
crypto_target_container_name
Displays information for the specified CryptoTarget container. If the -stat
parameter is specified with this operand, the CTC must be hosted on the local
node.
-cfg
Displays the configuration for the specified CTC.
-stat
Displays the runtime status for the specified CTC.
--show -tapepool
Displays configuration information for specified tape pools when used with the
-cfg option. Displays runtime status information for specified tape pools when
used with the -cfg option. This command is valid on all nodes. The following
operands are supported:
-all -cfg
Displays configuration information for all configured tape pools in the encryption
group.
-all -stat
Displays runtime status information for all configured tape pools in the encryption
group.
-label pool_label | -num pool_num
Displays tape pool configuration or runtime status information for a single tape
pool specified either by a tape pool label or a number. These operands must be
used with either the -stat or the -cfg option.
-cfg | -stat
Displays either configuration information or runtime status for the specified
tape pools.
--show -LUN
Displays Crypto LUN configuration or runtime status information for a specified
CTC. This command is valid on all nodes. The following operands are supported:
crypto_target_container_name
Specifies the CTC for which to display the Crypto LUN information.
LUN_Num
Specifies the number of the LUN for which to display information.
initiator_PWWN
Specifies the PWWN of the initiator.
-cfg | -stat
Displays either the configuration or the status of the specified Crypto LUN. The
configuration can be displayed on any node in the encryption group. To display
LUN status, the specified LUN must be hosted on the local node.
Fabric OS Command Reference
53-1003108-01
221
2
cryptoCfg
--show -rekey
Displays information about rekey sessions in progress. This command is valid on
all nodes. The following operands are mutually exclusive:
-all
Lists all rekey sessions in progress on the current node.
crypto_target_container_name
Lists all rekey sessions in progress for a specified CryptoTarget container. You
may further specify either one of the following operands:
LUN_Num
Lists all rekey sessions in progress for a specific Crypto LUN of the specified
CryptoTarget container.
initiator_PWWN
Lists all rekey sessions in progress for a specific initiator of the specified
CryptoTarget container.
--show -tape_sessions
Displays runtime tape session information. This command is valid on all nodes.
The following operands are mutually exclusive:
-all
Displays runtime information for all tape sessions in progress on the local node.
crypto_target_container_name
Displays runtime information for all tape sessions in progress for a specified
CryptoTarget container.
--clearstats -container
Clears compressed or uncompressed blocks and/or byte counters for the
specified containers. Specify one of the following operands:
-all
Clears blocks and/or byte counters for all CryptoTarget tape containers.
crypto_target_container_name
Clears blocks and/or byte counters for all CryptoLUNs of the specified
CryptoTarget tape container.
--clearstats -LUN
Clears compressed or uncompressed blocks and/or byte counters for a specific
CryptoLUN. The following operands are required:
crypto_target_container_name
Specifies the CryptoTarget tape container for the LUN.
LUN_Num
Specifies the number of the LUN to be cleared.
initiator_PWWN
Specifies the initiator port WWN for the specified LUN.
--refreshDEK
Rereads the mirror LUN metadata and updates the FPGA tables for the LUN if the
keyID in the metadata has changed. You must issue this command on the node of
the EE where the container that includes the mirror LUN is hosted. An RSA DPM
must be configured for the encryption group and replication mode must be
enabled for this command to succeed. This command fails if the specified LUN
was not added with -newLUN option. The refresh operation may cause a brief
disruption of the host I/O. The following operands are required:
crypto_target_container_name
Specifies the CryptoTarget container for the LUN.
222
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
LUN_Num
Specifies the number of the LUN whose metadata needs to be reread.
initiator_PWWN
Specifies the initiator port WWN for the specified LUN.
--reclaimWWN
Reclaims the WWNs of the specified member node or encryption engine. This
command removes the WWNs from the specified entity. Once removed you can
reallocate the WWNs. The reclaim operation is disruptive and prompts for
confirmation.
The following restrictions apply when you reallocate a WWN:
•
The reclaim operations must be executed on the group leader node. All encryption engines must be
online and the Group status must be "converged".
•
•
•
All nodes in the encryption group must run Fabric OS v7.0.0 or later.
You must commit all container changes prior to and following the reclaim operation.
You must perform a reclaim operation for any node or encryption engine that needs to be moved out
of an existing encryption group.
-membernode node_WWN
Specifies the node WWN of any member node in the encryption group. This
command frees up all WWNs associated with all encryption engines in the
specified member node. It also displays a list of containers that will be affected by
the reclaim operation.
--EE node_WWN slot
Specifies the node WWN of any encryption engine in the encryption group. This
command frees up all WWNs associated with the specified encryption engines for
reallocation. You must specify a slot number in addition to the EE node WWN. To
complete the reclaiming of an EE, you must remove the EE from the chassis after
the reclaim operation and commit the transaction.
-list
Displays a listing of crypto-target containers affected by the reclaim operation.
This operand is optional.
-cleanup
Removes all crypto configurations present on the member node after the WWNs
have been reclaimed. This command must be executed on the ejected member
node.
EXAMPLES
1.
Create a zone that includes initiator and target.
a.
Determine the device configuration.
FabricAdmin:switch> nsshow
{
Type Pid
COS PortName
NodeName
TTL(sec)
N 010600;2,3;10:00:00:00:c9:2b:c9:3a;20:00:00:00:c9:2b:c9:3a;na
NodeSymb: [35] "Emulex LP9002 FV3.82A1 DV5-4.81A4 "
Fabric Port Name: 20:06:00:05:1e:41:9a:7e
Permanent Port Name: 10:00:00:00:c9:2b:c9:3a
Port Index: 6
Share Area: No
Device Shared in Other AD: No
Redirect: No
Partial: No
The Local Name Server has 1 entry }
FabricAdmin:switch> nscamshow
Fabric OS Command Reference
53-1003108-01
223
2
cryptoCfg
nscamshow for remote switches:
Switch entry for 2
state rev owner
known v611 0xfffc01
Device list: count 13
Type Pid COS
PortName
NodeName
NL 0208d3;3;20:0c:00:06:2b:0f:72:6d;20:00:00:06:2b:0f:72:6d;
FC4s: FCP
PortSymb:[55]"LSI7404XP-LC BR A.1 03-01081-02D
FW:01.03.06 Port 1"
Fabric Port Name: 20:08:00:05:1e:34:e0:6b
Permanent Port Name: 20:0c:00:06:2b:0f:72:6d
Port Index: 8
Share Area: No
Device Shared in Other AD: No
Redirect: No
Partial: No
b.
Create and enable a zone named "itzone" that includes initiator and target.
FabricAdmin:switch> zonecreate itzone, \
"10:00:00:00:c9:2b:c9:3a; 20:0c:00:06:2b:0f:72:6d"
FabricAdmin:switch> cfgcreate itcfg, itzone
FabricAdmin:switch> cfgenable itcfg
You are about to enable a new zoning configuration.
This action will replace the old zoning configuration
with the current configuration selected.
Do you want to enable 'itcfg' configuration \
(yes, y, no, n): [no] y
zone config "itcfg" is in effect
Updating flash ...
2.
Create a disk CryptoTarget container to be hosted on the encryption engine.
FabricAdmin:switch> cryptocfg --create -container
disk my_disk_tgt1 0:00:00:05:1e:41:9a:7e
20:0c:00:06:2b:0f:72:6d 20:00:00:06:2b:0f:72:6d
Operation Succeeded
3.
\
Add an initiator to the CryptoTarget container and commit the transaction.
FabricAdmin:switch> cryptocfg --add -initiator my_disk_tgt
10:00:00:00:c9:2b:c9:3a 20:00:00:00:c9:2b:c9:3a
Operation Succeeded
FabricAdmin:switch> cryptocfg --commit
Operation Succeeded
4.
Display the CTC configuration.
FabricAdmin:switch> cryptocfg --show -container
my_disk_tgt -cfg
Container
name: my_disk_tgt
Type:
disk
EE node:
10:00:00:05:1e:41:9a:7e
EE slot:
0
Target:
20:0c:00:06:2b:0f:72:6d \
20:00:00:06:2b:0f:72:6d
VT:
20:00:00:05:1e:41:4e:1d \
20:01:00:05:1e:41:4e:1d
224
\
\
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
Number of host(s):
1
Configuration status:committed
Host:
10:00:00:00:c9:2b:c9:3a \
20:00:00:00:c9:2b:c9:3a
VI:
20:02:00:05:1e:41:4e:1d \
20:03:00:05:1e:41:4e:1d
Number of LUN(s):
0
Operation Succeeded
5.
Discover the LUNs seen by the initiators in the CryptoTarget container.
FabricAdmin:switch> cryptocfg --discoverLUN my_disk_tgt
Container name:
my_disk_tgt
Number of LUN(s):
1
Host:
10:00:00:00:c9:2b:c9:3a
LUN number:
0x0
LUN serial number:
200000062B0F726D0C000000
Key ID state:
Read write
Key ID:3a:21:6a:bd:f2:37:d7:ea:6b:73:f6:19:72:89:c6:4f
6.
Add a LUN to the CTC with encryption enabled.
FabricAdmin:switch> cryptocfg --add -LUN \
my_disk_tgt 0 10:00:00:00:c9:2b:c9:3a \
20:00:00:00:c9:2b:c9:3a -lunstate cleartext -encrypt
Operation Succeeded
7.
Commit the device configuration.
FabricAdmin:switch> cryptocfg --commit
Operation Succeeded
8.
Display Crypto LUN runtime status.
FabricAdmin:switch> cryptocfg --show -LUN \
my_disk_tgt 0 10:00:00:00:c9:2b:c9:3a -stat
Container name:
my_disk_tgt
Type:
disk
EE node:
10:00:00:05:1e:41:9a:7e
EE slot:
0
E hosting container:
current
Target:
20:0c:00:06:2b:0f:72:6d \
20:00:00:06:2b:0f:72:6d
Target PID:
0208d3
VT:
20:00:00:05:1e:41:4e:1d \
20:01:00:05:1e:41:4e:1d
VT PID:
012001
Number of host(s):
1
Number of rekey session(s):0
Host:
10:00:00:00:c9:2b:c9:3a \
20:00:00:00:c9:2b:c9:3a
Host PID:
010600
VI:
20:02:00:05:1e:41:4e:1d \
20:03:00:05:1e:41:4e:1d
VI PID:
012002
Number of LUN(s):
1
LUN number:
0x0
LUN type:
disk
LUN serial number:
200000062B0F726D0C000000
Encryption mode:
encrypt
Encryption format:
native
Encrypt existing data:
disabled
Fabric OS Command Reference
53-1003108-01
225
2
cryptoCfg
Rekey:
disabled
Internal EE LUN state:
Encryption enabled
Encryption algorithm:
AES256-XTS
Key ID state:
Read write
Key ID:3a:21:6a:bd:f2:37:d7:ea:6b:73:f6:19:72:89:c6:4f
Key creation time:
Sun Jun 1 20:21:32 2008
New LUN:
No
Replication LUN type:
Primary
Operation Succeeded
9.
Display Crypto LUN configuration.
FabricAdmin:switch> cryptocfg --show -LUN \
my_disk_tgt 0 10:00:00:00:c9:2b:c9:3a -cfg
EE node:
10:00:00:05:1e:41:9a:7e
EE slot:
0
Target:
20:0c:00:06:2b:0f:72:6d
20:00:00:06:2b:0f:72:6d
VT:
20:00:00:05:1e:41:4e:1d
20:01:00:05:1e:41:4e:1d
Number of host(s):
1
Configuration status: committed
Host:
10:00:00:00:c9:2b:c9:3a
20:00:00:00:c9:2b:c9:3a
VI:
20:02:00:05:1e:41:4e:1d
20:03:00:05:1e:41:4e:1d
LUN number:
0x0
LUN type:
disk
LUN status:
0
Encryption mode:
encrypt
Encryption format:
native
Encrypt existing data: disabled
Rekey:
disabled
Key ID:
not available
Operation Succeeded
\
\
\
\
10. Display the zone configuration (note that a frame redirection zone has been created automatically to
route traffic between host, VT, VI and target, VI, VT.)
FabricAdmin:switch> cfgshow
Defined configuration:
cfg: itcfg
itzone
cfg:
r_e_d_i_r_c__fg
red_1109_brcd200c00062b0f726d200200051e414e1d; red_______base
cfg: testcfg1
testzone1
zone: itzone 10:00:00:00:c9:2b:c9:3a; 20:0c:00:06:2b:0f:72:6d
zone: red_1109_brcd200c00062b0f726d200200051e414e1d
10:00:00:00:c9:2b:c9:3a; 20:0c:00:06:2b:0f:72:6d;
20:02:00:05:1e:41:4e:1d; 20:00:00:05:1e:41:4e:1d
zone: red_______base
00:00:00:00:00:00:00:01; 00:00:00:00:00:00:00:02;
00:00:00:00:00:00:00:03; 00:00:00:00:00:00:00:04
zone: testzone1
1,0
Effective configuration:
cfg: itcfg
zone: itzone 10:00:00:00:c9:2b:c9:3a
20:0c:00:06:2b:0f:72:6d
226
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2
To display the tape pool configuration:
FabricAdmin:switch> cryptocfg --show -container -all -cfg
Encryption group name: brocade
Number of Container(s): 2
Container name:
pc21_stk10k
Type:
tape
EE node:
10:00:00:05:1e:53:8a:28
EE slot:
0
Target:
50:01:04:f0:00:b2:ea:6c
50:01:04:f0:00:b2:ea:6b
VT:
20:00:00:05:1e:53:8a:24
20:01:00:05:1e:53:8a:24
Number of host(s):
1
Configuration status:
committed
Host:
10:00:00:06:2b:0f:41:0c
20:00:00:06:2b:0f:41:0c
VI:
20:02:00:05:1e:53:8a:24
20:03:00:05:1e:53:8a:24
Number of LUN(s):
1
Container name:
pc23_hplto3
Type:
tape
EE node:
10:00:00:05:1e:53:8a:28
EE slot:
0
Target:
50:01:10:a0:00:8c:28:ba
50:01:10:a0:00:8c:28:b9
VT:
20:08:00:05:1e:53:8a:24
20:09:00:05:1e:53:8a:24
Number of host(s):
1
Configuration status:
committed
Host:
10:00:00:05:1e:53:68:28
20:00:00:05:1e:53:68:28
VI:
20:0a:00:05:1e:53:8a:24
20:0b:00:05:1e:53:8a:24
Number of LUN(s):
1
\
\
\
\
\
\
\
\
To display all configured tape pools:
FabricAdmin:switch> cryptocfg --show -tapepool -all
Tape pool label:
Key life:
Encryption mode:
Encryption format:
Configuration status:
tpool.00001
0 (days)
encrypt
native
committed(2)
Tape pool label:
Key life:
Encryption mode:
Encryption format:
Configuration status:
tpool.00002
0 (days)
encrypt
native
committed(2)
Fabric OS Command Reference
53-1003108-01
227
2
cryptoCfg
To display CryptoTarget container runtime status information For a disk LUN with rekeying enabled:
FabricAdmin:switch> cryptocfg --show -tapepool \
-LUN my_disk_tgt 0x0 10:00:00:db:69:78:93:0e -stat
Container name:
my_disk_tgt
Type:
disk
EE node:
10:00:00:05:1e:53:75:01
EE slot:
0
Target:
21:00:00:04:cf:6e:58:2c \
20:00:00:04:cf:6e:58:2c
Target PID:
0107d5
VT:
20:28:00:05:1e:53:74:fd \
20:29:00:05:1e:53:74:fd
VT PID:
012805
Number of host(s):
1
Number of rekey session(s):1
Host:
10:00:00:db:69:78:93:0e \
20:00:00:db:69:78:93:0e
Host PID:
000000
VI:
20:36:00:05:1e:53:74:fd \
20:37:00:05:1e:53:74:fd
VI PID:
012806
Number of LUN(s):
1
LUN number:
0x0
LUN type:
disk
LUN serial number:
20000004CF6E582C
Encryption mode:
encrypt
Encryption format:
native
Encrypt existing data:
enabled
Rekey:
enabled
LUN state:
First time re-key is in progress
Encryption algorithm:
AES256-XTS
Key ID state:
Re-key
Key ID:eb:d0:48:ce:e9:f2:40:89:da:d4:7e:10:18:72:fa:15
Key creation time:
Fri May 16 02:03:48 2008
Key life:
300 (days)
Rekey status:
0
Key expiration time:
Sun May 18 04:03:48 2008
Operation Succeeded
To display CryptoTarget container configuration information For a disk LUN with rekeying enabled:
FabricAdmin:switch> cryptocfg --show -LUN my_disk_tgt 0x0
10:00:00:db:69:78:93:0e -cfg
EE node:
10:00:00:05:1e:53:75:01
EE slot:
0
Target:
21:00:00:04:cf:6e:58:2c \
20:00:00:04:cf:6e:58:2c
VT:
20:28:00:05:1e:53:74:fd \
20:29:00:05:1e:53:74:fd
Number of host(s):
1
Configuration status:
committed
Host:
10:00:00:db:69:78:93:0e \
20:00:00:db:69:78:93:0e
VI:
20:36:00:05:1e:53:74:fd \
20:37:00:05:1e:53:74:fd
LUN number:
0x0
LUN type:
disk
LUN status:
0
Encryption mode:
encrypt
228
Fabric OS Command Reference
53-1003108-01
cryptoCfg
Encryption format:
Encrypt existing data:
Rekey:
Key ID:
Key life:
Rekey status:
Operation Succeeded
2
native
enabled
enabled
not available
300 (days)
0
To display all tape sessions in progress on the local node:
FabricAdmin:switch> cryptocfg --show -tape_sessions -all
Number of tape session(s):
2
Container name:
apps92
EE node:
10:00:00:05:1e:43:ee:00
EE slot:
2
Target:
50:03:08:c0:9c:e5:a0:01
50:03:08:c0:9c:e5:a0:00
Target PID:
8e0100
VT:
20:00:00:05:1e:53:77:e8
20:01:00:05:1e:53:77:e8
VT PID:
019001
Host:
10:00:00:00:c9:52:00:ba
20:00:00:00:c9:52:00:ba
Host PID:
8e0200
VI:
20:02:00:05:1e:53:77:e8
20:03:00:05:1e:53:77:e8
VI PID:
019002
LUN number:
0x0
Tape session number:
0
Number of uncompressed blocks: 37466
Number of compressed blocks:
36587
Number of uncompressed bytes:
2455059456
Number of compressed bytes:
1138031028
LUN number:
0x1
Tape session number:
1
Number of uncompressed blocks: 0
Number of compressed blocks:
0
Number of uncompressed bytes:
0
Number of compressed bytes:
0
Operation succeeded.
\
\
\
\
To reclaim all WWNs associated with an encryption engine:
switch:admin> cryptocfg --reclaimWWN -EE 10:00:00:05:1e:39:b3:96 12
Warning: WWN reclaim operation may result in momentary IO disruption.
ARE YOU SURE (yes, y, no, n): [no] y
Operation succeeded.
Please use "cryptocfg --commit" to commit the configuration.
To attempt to reclaim all WWNs associated with a member node when containers are still present on the
node:
switch:admin> cryptocfg --reclaimWWN -membernode 10:00:00:05:33:13:7a:e8
Warning: WWN reclaim operation may result in momentary IO disruption.
Make sure that the Membernodes are not hosting any container.
ARE YOU SURE (yes, y, no, n): [no] y
Operation failed: Reclaim WWN's is not allowed as the Membernode
still hosts containers. Please delete or move the containers.
Fabric OS Command Reference
53-1003108-01
229
2
cryptoCfg
To reclaim all WWNs associated with a member node when no containers are present on the node:
switch:admin> cryptocfg --reclaimWWN -membernode 10:00:00:05:33:13:7a:e8
Warning: WWN reclaim operation may result in momentary IO disruption.
Make sure that the Membernodes are not hosting any container.
ARE YOU SURE (yes, y, no, n): [no] y
Operation succeeded.
Please use "cryptocfg --commit" to commit the configuration.
Please eject the membernode from the EG "cryptocfg
--eject -membernode 10:00:00:05:33:13:7a:e8".
Then deregister the membernode "cryptocfg --dereg
-membernode 10:00:00:05:33:13:7a:e8".
On the membernode [10:00:00:05:33:13:7a:e8]
execute "cryptocfg --reclaimWWN -cleanup".
To display the crypto-target containers affected by the reclaim operation:
switch:admin> cryptocfg --reclaimWWN -membernode membernode \
10:00:00:05:33:13:7a:e8 -list
Following is the list of containers using the reclaimed WWN base.
[ 1] H183SB182_1
[ 2] H183SB182_2
[ 3] H183SB182_3
[ 4] H183SB182_4
[ 5] H183SB182_5
[ 6] H183SB182_6
Operation succeeded.
To clean up the stale crypto configurations from the ejected member node.
switch:admin> cryptocfg --reclaimWWN -cleanup
Warning: There are stale (Container|HA|Tape) cryptodb \
configurations. Please confirm to delete them.
ARE YOU SURE (yes, y, no, n): [no] y
Warning: These are the list of crypto configuration \
files to be cleaned up:
Inside /etc/fabos/mace (crypto_dek.db.0, crypto_dev.db.0, \
crypto_hac.db.0, crypto_pool.db.0, crypto_wwn.db.0).
ARE YOU SURE (yes, y, no, n): [yes] y
Operation Succeeded.
FUNCTION
5. Transaction management
SYNOPSIS
cryptocfg --help transcfg
cryptocfg --commit [-force]
cryptocfg --transabort transaction_ID
cryptocfg --transshow
DESCRIPTION
Use these cryptoCfg commands to manage the transaction mechanism for those functions that require
configuration changes to be committed before they take effect. These functions include "3. High
Availability (HA) cluster configuration" and "4. Storage device configuration and management"
Transaction commands must be invoked on the group leader.
230
Fabric OS Command Reference
53-1003108-01
cryptoCfg
OPERANDS
2
The cryptoCfg transaction management function has the following operands:
--help transcfg
Displays the synopsis for the transaction management function.
--commit
Commits the transaction. This command saves the defined configuration to
nonvolatile storage. Changes are persistent across reboots and power cycles.
This command overwrites existing configuration parameters and therefore
prompts for confirmation. This command is permitted only when the encryption
group is in a converged state.
The following operand is optional:
-force
Commits the transaction without confirmation.
--transabort transaction_ID
Aborts a pending database transaction for any device configurations invoked
earlier through the CLI or DCFM interfaces. The following operand is required:
transaction_ID
Specifies the ID of the transaction to be aborted. Use the --transshow command
to determine the currently pending transaction ID.
--transshow
Displays the pending database transaction for any device configurations invoked
earlier through the CLI or DCFM interfaces. The command displays the
transaction status (completed or pending), the transaction ID, and the transaction
owner (CLI or DCFM)
FUNCTION
6. Device decommissioning
SYNOPSIS
cryptocfg --help -decommission
cryptocfg --decommission -container container_name
-initiator initiatator _PWWN -LUN LUN_num
cryptocfg --delete -decommissionedkeyids
cryptocfg --show -decommissionedkeyids
cryptocfg --show -vendorspecifickeyid key_ID
DESCRIPTION
Use these cryptoCfg commands to decommission a disk LUN in the event that the storage device is to
be reprovisioned, retired, or returned to the vendor. The decommission function renders all data on the
disk media inaccessible before decommissioning the device.
Device decommissioning deletes or renders invalid all important information including keys stored in the
key vault, on the chip, and from the various internal caches, and it erases the metadata on the media to
ensure that the data on the decommissioned device is irrecoverable.
The following restrictions apply to device decommissioning:
•
Devices not encrypted on the Brocade Encryption platform or devices in cleartext cannot be
decommissioned with this command.
•
•
All nodes in the encryption group must run Fabric OS v6.4.0 or later.
All nodes in the encryption group must run Fabric OS v7.1.0 or later when keyvault type is not set to
DPM or LKM.
Fabric OS Command Reference
53-1003108-01
231
2
cryptoCfg
OPERANDS
•
All nodes in the encryption group must run Fabric OS v6.4.0 or later when keyvault type is set to
DPM or LKM.
•
Device decommissioning does not work across a reboot. Rebooting terminates an ongoing
decommissioning process and the command must be reissued after completing the reboot.
•
Device decommissioning is supported with the DPM, TKLM, KMIP, ESKM, TEKA, and LKM key
vaults.
•
•
Decommissioning of tape devices or snap drive volumes is currently no supported.
Decommissioning does not automatically delete the keys. You must manually delete the keys from
the key vault to complete the operation.
This command has the following operands:
--help -decommission
Displays the command usage help for the device decommissioning commands.
--decommission
Decommissions a disk LUN hosted in a specified container as seen from the
initiator. You must issue this command from the node that hosts the container.
Upon successful completion of a decommissioning operation, the LUN is deleted
from all the containers hosting it. All active paths to the LUN are lost; there is no
need to execute a decommissioning operation separately for each path
associated with the LUN. A commit operation is not required. The following
operands are required:
-container container_name
Specifies the name of the container that hosts the LUN.
-initiator initiatator_PWWN
Specifies the initiator port WWN.
-LUN LUN_num
Specifies the number of the LUN to be decommissioned.
--delete -decommissionedkeyids
Purges all key IDs associated with decommissioned LUNs from the internal
cache. You must delete the keys manually from the key vaults before purging the
cache.
--show -decommissionedkeyids
Displays the key IDs associated with decommissioned LUNs.
--show -vendorspecifickeyid key_ID
Displays vendor specific key_ID or UUID for a given key_ID.
EXAMPLES
The following steps must be performed to decommission a disk LUN:
1.
Execute the decommission operation on a LUN
switch:admin> cryptocfg --decommission -container disk_ct0 \
-initiator 21:01:00:1b:32:29:5d:1c -LUN 0
Operation succeeded.
232
Fabric OS Command Reference
53-1003108-01
cryptoCfg
2.
2
Display the key IDs to be deleted manually from the keyvault
switch:admin> cryptocfg --show -decommissionedkeyids
Please Delete these keyed from the vault:
76:a0:01:f2:34:6e:44:cc:35:e9:be:71:64:ca:5e:90
switch:admin> cryptocfg --show vendorspecifickeyid
aa:8b:91:b0:35:6f:da:92:8a:72:b3:97:92:1b:ca:b4
uuid = b7e07a6a-db64-40c2-883a-0bc6c4e923e6
3.
Manually delete the keys from the vault. This step requires accessing the Key Vault GUI and deleting
the keys manually.
4.
Delete the key IDs from the internal cache.
switch:admin> cryptocfg --delete -decommissionedkeyids
operation succeeded
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
233
2
dataTypeShow
dataTypeShow
Displays sample data stream types used in some diagnostic commands.
SYNOPSIS
DESCRIPTION
NOTES
OPERANDS
datatypeshow [-seed value]
Use this command to display sample data stream types used in diagnostic commands. There are 25
different sample data types. The command displays an example of each data stream.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
-seed value
Specify the data pattern seed value. This operand is optional. The default value is
0.
EXAMPLES
To display sample data streams you can use with diagnostics:
switch:admin> datatypeshow
Pattern
BYTE_FILL
WORD_FILL
QUAD_FILL
BYTE_NOT
WORD_NOT
QUAD_NOT
BYTE_RAMP
WORD_RAMP
QUAD_RAMP
BYTE_LFSR
RANDOM
CRPAT
CSPAT
CHALF_SQ
CQTR_SQ
RDRAM_PAT
jCRPAT
jCJTPAT
jCSPAT
PRED_RAND
SMI_TEST
CJPAT
QUAD_NOTP
JSPAT
JTSPAT
SEE ALSO
234
type
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
example
15 15 15 15 15 15 15 15 15 15 15 15 15 15 15 15
0015 0015 0015 0015 0015 0015 0015 0015
00000015
00000015
00000015
00000015
15 ea 15 ea 15 ea 15 ea 15 ea 15 ea 15 ea 15 ea
0015 ffea 0015 ffea 0015 ffea 0015 ffea
00000015
ffffffea
00000015
ffffffea
15 16 17 18 19 1a 1b 1c 1d 1e 1f 20 21 22 23 24
0015 0016 0017 0018 0019 001a 001b 001c
00000015
00000016
00000017
00000018
1c 38 71 e3 c6 8d 1a 34 68 d0 a0 41 82 04 09 12
14 5b 52 66 77 c5 bc 76 5a 6e d3 e2 de 3b 6b 40
bc bc 23 47 6b 8f b3 d7 fb 14 36 59 bc bc 23 47
7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f
b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5 b5
d9 26 d9 26 d9 26 d9 26 d9 26 d9 26 d9 26 d9 26
ff 00 ff 00 ff 00 ff 00 ff 00 ff 00 ff 00 ff 00
be d7 23 47 6b 8f b3 14 5e fb 35 59 be d7 23 47
7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e
7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f 7f
00000015
11111126
22222237
33333348
00000015
ffffffea
00000015
ffffffea
7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e 7e
00000015
fffffffa
00000015
fffffffa
7e 7e 7e 7e 7e 7e 7e 7e 9e f8 50 81 e7 50 aa c9
7e 7e 7e 7e 7e 7e 7e 7e 9e f8 50 81 e7 50 aa c9
None
Fabric OS Command Reference
53-1003108-01
date
2
date
Displays or sets the switch date and time.
SYNOPSIS
DESCRIPTION
date ["newdate"]
Use this command to display or set the date and time. All switches maintain current date and time in flash
memory. Date and time are used for logging events. Normal switch operation does not depend on the
date and time; a switch with incorrect date values continues to function properly.
This command sets a common date and time for the entire fabric. A change in date or time to one switch
is forwarded to the principal switch and distributed to the fabric. It may take up to 64 seconds for the
switches in the fabric to be synchronized. However, if an FCS policy is enabled, this command can be
executed only on the Primary FCS switch, and only the primary FCS switch can distribute the time stamp
to all other switches in the fabric.
If Virtual Fabrics are enabled, the date is set for the entire chassis, including all logical switches.
The date specified is always the local switch time, taking into account daylight saving time and the time
zone setup of the switch. Each switch takes care of converting the GMT time distributed fabric-wide to its
local time. Refer to tsTimeZone for more information on time zone support.
If the switch is operating in FICON Management Server mode (fmsMode), setting the date is subject to
the director clock alert mode (DCAM). If DCAM is 1, the operator issues a warning that the switch date is
about to change. The operator then prompts to confirm the change with a yes or no response.
NOTES
This command becomes read-only if external NTP synchronization is enabled. For more information,
refer to tsClockServer.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
"newdate"
Specify the new date and time enclosed in double quotation marks. this operand is
optional; if omitted, the current date and time is displayed. Date and time are
specified as a string in the mmddhhmmyy format.
mm
Specifies the month. Valid values are 01 to 12.
dd
Specifies the date. Valid values are 01 to 31.
hh
Specifies the hour. Valid values are 00 to 23.
mm
Specifies the minutes. Valid values are 00 to 59.
yy
Specifies the year, valid values are 00 to 37 and 70 to 99. Year values from 70 to
99 are interpreted as 1970 to 1999; year values from 00 to 37 are interpreted as
2000 to 2037.
Fabric OS Command Reference
53-1003108-01
235
2
date
EXAMPLES
To display the current date and time and then modify it:
switch:admin> date
Tue Oct 22 14:05:10 UTC 2013
switch:admin> date "1022140613"
Tue Oct 22 14:06:00 UTC 2013
SEE ALSO
236
errShow, ficonCupSet, ficonCupShow, portLogShow, tsClockServer, tsTimeZone, upTime
Fabric OS Command Reference
53-1003108-01
dbgShow
2
dbgShow
Displays current values of debug and verbosity levels of the specified module.
SYNOPSIS
DESCRIPTION
NOTES
OPERANDS
dbgshow [module_name]
Use this command to display the current values of debug and verbosity levels of the specified module. If
no module name is specified, this command displays a listing of all modules along with debug and
verbosity levels.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
module_name
Specifies the name of the module for which you want to view the debug and
verbosity levels. Module names are case-sensitive. This operand is optional.
EXAMPLES
To display information about a specific module named NS:
switch:admin> dbgshow NS
Module NS,
debug level = 1, verbose level = 1
SEE ALSO
setDbg
Fabric OS Command Reference
53-1003108-01
237
2
defZone
defZone
Sets or displays the default zone access mode.
SYNOPSIS
DESCRIPTION
defzone [--noaccess | --allaccess | --show]
Use this command to display or set the Default Zone access mode. Setting the Default Zone mode
initializes a zoning transaction (if one is not already in progress), and create reserved zoning objects.
A default zone controls device access when zoning is not enabled. When a user-specified zoning
configuration is not enabled, Default Zone is in effect, allowing access to all devices. When a
user-specified zone configuration is enabled, it overrides the Default Zone access mode.
NOTES
This command must be issued from the primary FCS switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Zone object names beginning with the d_efault_ prefix are reserved for default zoning use. Editing of
these objects is not permitted. Therefore, cfgShow does not display the names of these objects.
If d_efault_Cfg is the effective zone configuration, both cfgShow and cfgActvShow do not display
d_efault_Cfg as the effective zone configuration.
OPERANDS
This command has the following operands:
--noaccess
Sets the default zone access mode to No Access, initializes a zoning transaction
(if one is not already in progress), and creates the reserved zoning objects
equivalent to the following zoning commands:
•
•
cfgCreate "d_efault_Cfg","d_efault_Zone"
zoneCreate "d_efault_Zone","00:00:00:00:00:00:00:01"
A cfgSave, cfgEnable, or cfgDisable command must be issued after issuing this
command to commit the changes and distribute them to the fabric; for example:
•
•
defzone --noaccess
cfgsave
An audit log record is generated for each execution of this command.
When No Access default zone is activated, the following conditions apply:
•
•
If the current effective zone configuration is disabled with the cfgDisable
command, the local switch converts this command to the equivalent of
cfgEnable "d_efault_Cfg".
If zoning receives a cfgDisable command from a remote switch that does not
support default zoning, zoning rejects the cfgDisable command in the
second phase of RCS because the remote switch does not convert the
cfgDisable command to cfgEnable "d_efault_Cfg".
--allaccess
Sets the default zone access mode to All Access, initiates a zoning transaction (if
one is not already in progress), and deletes the reserved zoning objects by
performing the equivalent to the following zoning commands:
•
•
238
cfgDelete "d_efault_Cfg"
zoneDelete "d_efault_Zone"
Fabric OS Command Reference
53-1003108-01
defZone
2
A cfgSave, cfgEnable, or cfgDisable command must be performed subsequent
to the use of this command to commit the changes and distribute them to the
fabric. If a cfgSave is performed and the fabric is already in the No Access default
zone state, a cfgDisable is sent to the fabric. For example:
•
•
defzone --allaccess
cfgsave
An audit log record is generated for each use of this command.
--show
Displays the current state of the default zone access mode.
EXAMPLES
To create a default zone configuration:
primaryfcs:admin> cfgactvshow
Effective configuration:
No Effective configuration
primaryfcs:admin> defzone --noaccess
primaryfcs:admin> cfgsave
primaryfcs:admin> defzone --show
Default Zone Access Mode
committed - No Access
transaction - No Transaction
primaryfcs:admin> cfgactvshow
Effective configuration:
No Effective configuration: (No Access)
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
239
2
diagClearError
diagClearError
Clears the diagnostics failure status.
SYNOPSIS
diagclearerror [[--slot] slot] -all
DESCRIPTION
Use this command to clear the diagnostics failure status. When used without operands, this command
clears all port failure flags.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
--slot slot
Specify the slot on which to clear the diagnostics failure status. The default is set
to 0 and designed to operate on fixed-port-count products.
-all
If specified, all blades clear.
EXAMPLES
To clear the diag software flag:
switch:admin> diagclearerror --slot 8
ERROR: DIAG CLEARERR
Diagnostics Errors Cleared, port: 8/31
Err# 0120041 081F
SEE ALSO
240
None
Fabric OS Command Reference
53-1003108-01
diagDisablePost
2
diagDisablePost
Disables the power-on self-test (POST).
SYNOPSIS
DESCRIPTION
NOTES
diagdisablepost
Use this command to disable POST. A reboot is not required for this command to take effect. Use the
diagPost command to display the current POST status, and use diagEnablePost to enable POST.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable the POST:
switch:admin> diagdisablepost
Config update Succeeded
Diagnostic POST is now disabled.
SEE ALSO
diagEnablePost, diagPost
Fabric OS Command Reference
53-1003108-01
241
2
diagEnablePost
diagEnablePost
Enables the power-on self-test (POST).
SYNOPSIS
DESCRIPTION
diagenablepost
Use this command to enable POST. A reboot is not required for this command to take effect. POST
includes two phases: POST Phase I mainly tests hardware and POST Phase II tests system functionality.
Use the diagPost command to display the current POST status, and use diagDisablePost to disable
POST.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable POST:
switch:admin> diagenablepost
Config update Succeeded
Diagnostic POST is now enabled.
SEE ALSO
242
diagDisablePost, diagPost
Fabric OS Command Reference
53-1003108-01
diagHelp
2
diagHelp
Displays diagnostic command information.
SYNOPSIS
DESCRIPTION
diaghelp
Use this command to display a short description of diagnostic commands.
Use default operands when running diagnostics commands. Non-default settings require detailed
knowledge of the underlying hardware and are intended for support personnel only. Contact support if
you want to use these operands.
NOTES
The diagHelp command displays diagnostic commands that may not be available. Execute help
command to verify availability.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display diagnostic command information:
switch:admin> diaghelp
bpportloopbacktest
bpturboramtest
ceeportloopbacktest
ceeturboramtest
(output truncated)
SEE ALSO
Functional test of port via
blade processor path.
MBIST test for AP blade BP ASICs
Functional test of port N->N path.
MBIST test for ASICs
None
Fabric OS Command Reference
53-1003108-01
243
2
diagPost
diagPost
Displays the diagnostic power-on self-test (POST) configuration.
SYNOPSIS
DESCRIPTION
NOTES
diagpost
Use this command to display the current POST configuration. Use diagEnablePost or diagDisablePost
to modify the POST configuration.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the current POST configuration:
switch:admin> diagpost
Diagnostic POST is currently disabled.
SEE ALSO
244
None
Fabric OS Command Reference
53-1003108-01
diagRetry
2
diagRetry
Sets or displays diagnostic retry mode.
SYNOPSIS
DESCRIPTION
diagretry [mode | -show]
Use this command to enable retry mode if the mode value is nonzero and to disable the retry mode if the
mode value is 0. The mode value is saved in nonvolatile memory until you change the mode. Changes
made by this command do not require a reboot to take effect.
Retry mode modifies the behavior of the diagnostic test methods, power-on self-test (POST), and burn-in
scripts. The exact behavior depends on the tests and scripts that are run.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following optional operands:
mode
Specify 1 to enable retry mode. Specify 0 to disable the feature.
-show
Displays the current mode setting. The --show option is equivalent to using the
command without operands.
EXAMPLES
To view and modify the current retry mode value:
switch:admin> diagretry -show
Diagnostic Retry Mode is currently enabled.
switch:admin> diagretry 0
Config update Succeeded
Diagnostic Retry Mode is now disabled.
switch:admin> diagretry 1
Config update Succeeded
Diagnostic Retry Mode is now enabled.
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
245
2
diagShow
diagShow
Displays diagnostics status.
SYNOPSIS
DESCRIPTION
NOTES
diagshow
[--slot number]
[-uports itemlist]
[-bports itemlist]
[-use_bports value]
Use this command to display the diagnostics status for the specified list of blade or user ports.
On 10 Gbps and 16 Gbps (Condor3-based) platforms, the following output fields display invalid values,
unless diagShow is executed while the spinFab or the portTest tests are running: "Speed", "FrTX",
"FrRX", "LLI Errs", "Loopback", "Total Diag Frames Tx" and "Total Diag Frames Rx".
You cannot interrupt the test by pressing the return key (<cr>).
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following optional operands:
--slot number
Specify which slot to operate on. If this option is not specified, the default slot 0 is
used. The default slot is designed to operate on fixed-port-count products. By
default, this command displays information for all user ports in the system.
-uports itemlist
Specify a list of user ports.
-bports itemlist
Specify a list of blade ports.
-use_bports value
If this value is nonzero, this command displays the diagnostics status for the blade
ports specified in -use_bports; otherwise, the command displays information for
the user ports specified in -uports. The default value is 0.
EXAMPLES
To display diagnostic status on a switch blade:
switch:admin> diagshow
Diagnostics Status: Fri Feb 08 15:25:24 2002
Slot: 1 UPORTS
Port
BPort
Diag
Active
Speed
0
15
OK
UP
2G Auto
1
14
OK
UP
2G Auto
2
13
OK
UP
2G Auto
3
12
OK
UP
2G Auto
4
31
OK
UP
2G Auto
5
30
OK
UP
2G Auto
6
29
OK
UP
2G Auto
7
28
OK
UP
2G Auto
8
47
OK
UP
2G Auto
(output truncated)
SEE ALSO
246
......
......
......
......
......
......
......
......
......
......
itemList
Fabric OS Command Reference
53-1003108-01
distribute
2
distribute
Distributes data to switches in a fabric.
SYNOPSIS
DESCRIPTION
distribute -p policy_list -d switch_list
Use this command to distribute data to a specified list of switches in the fabric. The distributed data must
be from the list of currently supported policy sets:
SCC
Switch Connection Control Policy
DCC
Device Connection Control Policy
PWD
Password Database and Password Configuration Policy
AUTH
E_Port and F_Port Authentication Policy
FCS
Fabric Configuration Server Policy
Each supported database has a switch-local configuration parameter that controls whether the database
can be distributed and accepts distributions. Use the fddCfg command to view and modify these
parameters.
NOTES
IP Filter policies cannot be distributed with the distribute command. Use the chassisDistribute
command.
The password database received from a switch running pre-v6.3.0 firmware will be rejected by a Virtual
Fabric-enabled v6.3.0 chassis if it has more than one logical switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
-p policy_list
Specify the list of policy sets, also called security databases, to be distributed.
policy_list is a semicolon-separated list. Valid values include SCC, DCC, PWD,
AUTH, and FCS.
-d switch_list
Specify the list of switches that should receive the data distribution. The
switch_list is a semicolon-separated list of one of the following:
•
•
•
Switch domain IDs
Switch names
Switch WWNs
A wildcard (*) may be specified to include all switches in the fabric that support the
distribute feature.
EXAMPLES
To distribute the Switch Connection Control Policy and Device Connection Control Policy to domains 3
and 5 in the fabric:
switch:admin> distribute -p "SCC;DCC" -d "3;5"
Fabric OS Command Reference
53-1003108-01
247
2
distribute
To distribute the Switch Connection Control Policy, Fabric Configuration Server Policy, and Password
database to all domains in the fabric that support the distribute feature:
switch:admin> distribute -p "SCC;FCS;PWD" -d "*"
Wildcard domains are:
1 3 5
To distribute the FCS policy, and the Password database to all domains in the fabric that support the
distribute feature:
switch:admin> distribute -p "FCS;PWD" -d "*"
To distribute the AUTH and FCS policies to all switches in the fabric that run Fabric OS v5.3.0 or later:
switch:admin> distribute -p "AUTH;FCS" -d "*"
To distribute the AUTH and SCC policies to domains 1 and 3 in the fabric:
switch:admin> distribute -p "AUTH;SCC" -d "1;3"
SEE ALSO
248
fddCfg
Fabric OS Command Reference
53-1003108-01
dlsReset
2
dlsReset
Disables Dynamic Load Sharing (DLS).
SYNOPSIS
DESCRIPTION
dlsreset
Use this command to disable Dynamic Load Sharing.
If DLS is turned off, load sharing calculations are used only to place new routes. Once placed, existing
routes are never moved from one output E_Port to another, unless the original output E_Port is no longer
a recognized path to the remote domain. Optimal balance is rarely achieved with this setting. Refer to the
dlsSet help page for a full description of load sharing options, including the Lossless feature.
The behavior of this command depends on the routing policies configured on the switch:
•
If a port-based routing policy is in place, DLS is disabled by default, and dlsReset returns the DLS
setting to default. If Lossless was enabled, this command removes the Lossless option along with
the DLS feature and returns a message stating that "DLS is not set".
•
If an exchange-based routing policy is in place, DLS is always enabled. It cannot be disabled and
the dlsReset command fails. The command generates a message stating that "DLS cannot be
changed with current routing policy". If Lossless is enabled, the feature remains enabled until you
disable it with the dlsSet --disable -lossless command.
•
If DLS is already disabled, the command output confirms the disabled status: "DLS is not set
(unchanged)."
Refer to aptPolicy for information on routing policies.
NOTES
The Lossless feature is not supported on GbE ports and FCoE ports. On unsupported platforms, this
command exits with an appropriate message.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable the Dynamic Load Sharing option on a switch with a port-based routing policy and DLS
enabled:
switch:admin> dlsreset
DLS is not set
To execute dlsReset on a switch with an exchange-based routing policy and DLS enabled:
switch:admin> dlsreset
DLS cannot be changed with current routing policy
SEE ALSO
aptPolicy, dlsSet, dlsShow
Fabric OS Command Reference
53-1003108-01
249
2
dlsSet
dlsSet
Enables Dynamic Load Sharing (DLS) without frame loss.
SYNOPSIS
dlsset
dlsset --enable -lossless
dlsset --disable -lossless
dlsset --help
DESCRIPTION
Use this command to enable or disable Dynamic Load Sharing (DLS) in the event of a fabric change, to
configure DLS without frame loss, and to display the DLS configuration.
Dynamic load sharing optimizes the utilization of the interswitch links (ISLs) by rebalancing the paths
going over the ISLs whenever there is a fabric event that may result in a sub-optimal utilization of the ISL.
Dynamic rebalancing can be triggered by any one of the following events:
•
•
•
A change in the fabric occurs.
A local E_Port (including trunk ports) goes up or down.
A local Fx_Port goes down.
When used without operands, this command enables Dynamic Load Sharing on a switch (legacy DLS
behavior). Frames may be lost during reroute operations. If the switch has an exchanged-based routing
policy, DLS is enabled by default and this command fails with the following message: "DLS can not be
changed with current routing policy."
During the load sharing recomputation, existing routes may be moved to maintain optimal load balance.
Frame loss is unavoidable when a port goes down. To prevent frames from being lost during this
operation, you can enable DLS without frame loss by issuing this command with the --enable -lossless
option.
Dynamic load sharing without frame loss is supported in logical fabrics and is configured per logical
switch. However, there is a potential impact on other logical switches because they share the same
hardware. Chassis permissions are required to configure DLS in a logical fabric environment.
For example, assume a chassis is partitioned as follows: logical switch LS1 consists of ports 1/0-1/5, and
logical switch LS2 consists of ports 1/6-1/10. Lossless is enabled on logical switch LS1. Because the
ports 1/0-1/10 share the same chip, traffic in LS2 is affected whenever traffic for LS1 on ports 1/0-1/5 is
rebalanced. The impact on LS2 depends on the configuration on LS2:
250
•
If the Lossless feature is enabled on LS1, traffic pauses and resumes without frame loss on both
switches at the same time.
•
If the Lossless feature is disabled on LS1, traffic on LS2 is not affected.
Fabric OS Command Reference
53-1003108-01
dlsSet
NOTES
2
For switches running Fabric OS v7.1.0 or later, you can enable Lossless (or enable Fabric Management
Server mode) when XISL is enabled and enable XISL when Lossless or Fabric Management Server
mode is enabled.
When you downgrade from Fabric OS v7.1.x to Fabric OS v7.0.x the following rules apply: If Lossless (or
Fabric Management Server mode) and XISL use are not enabled at the same time, firmware download
can be executed. If both of them are enabled, firmware download is rejected with an error message.
If the active control processor (CP) runs Fabric OS v7.1.x or later, and the standby CP runs Fabric OS
v7.0.x and if both Lossless (or Fabric Management Server mode) and XISLs are enabled, High
Availability synchronization will fail. Otherwise, standby CP will synchronize with the active CP. After the
synchronization of the active and standy CP, enabling Lossless (or Fabric Management Server mode),
when XISL is enabled, is rejected with an error message. Enabling XISL, when Lossless (or Fabric
Management Server mode) is enabled, is also rejected with an error message.
Use the configure command to disable XISL use.
Lossless is supported with both exchange-based and port-based routing policies. Behavior depends on
the kind of policy configured and concurrent IOD settings. Refer to the Fabric OS Administrator's Guide
for information on how to optimize your configuration. Refer to the aptPolicy help page for more
information on routing policies.
The Lossless feature is not supported on GbE ports and FCoE. On unsupported platforms, this
command exits with an appropriate message.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
--enable -lossless
Enables the Lossless feature. Frame loss is reduced while the path is rerouted. If
DLS is set on the switch, this command adds the Lossless feature to the existing
DLS legacy mode. If DLS is not set on the switch, this command enables both
DLS and the Lossless feature. The Lossless feature is disabled by default.
--disable -lossless
Disables the previously enabled Lossless feature. Execution of this command is
equivalent to the legacy dlsSet command. Dynamic load balancing is enforced
but not without frame loss. DLS (legacy mode) continues to be enabled after
Lossless is disabled. Use dlsReset to disable DLS completely.
--help
Displays the command usage.
EXAMPLES
DLS configuration commands on a switch with an exchange-based policy:
switch:admin> aptpolicy
Current Policy: 3 0(ap)
3 0(ap) : Default Policy
1: Port Based Routing Policy
3: Exchange Based Routing Policy
0: AP Shared Link Policy
1: AP Dedicated Link Policy
switch:admin> dlsshow
DLS is set by default with current routing policy
DLS is set with Lossless enabled
Fabric OS Command Reference
53-1003108-01
251
2
dlsSet
switch:admin> dlsreset
DLS can not be changed with current routing policy
switch:admin> dlsset
DLS can not be changed with current routing policy
switch:admin> dlsset --enable -lossless
Lossless is set
switch:admin> dlsset --disable -lossless
Lossless is not set
switch:admin> dlssshow
DLS is set by default with current routing policy
DLS configuration commands on a switch with a port-based policy:
switch:admin> dlsshow
DLS is set by default with current routing policy
DLS is set with Lossless enabled
switch:admin> dlsreset
DLS is not set
switch:admin> dlsshow
DLS is not set
switch:admin> dlsset --enable -lossless
DLS and Lossless are set
switch:admin> dlsshow
DLS is set with Lossless enabled
switch:admin> dlsset
Lossless is set (unchanged)
switch:admin> dlsset --disable -lossless
Lossless is not set
switch:admin> dlsshow
DLS is not set
252
Fabric OS Command Reference
53-1003108-01
dlsSet
2
To attempt to enable Lossless while XISL use is enabled:
switch:admin> dlsset --enable -lossless
Lossless option cannot be enabled when XISL use is allowed.
Please disable the switch with 'switchdisable' and run \
'configure' to disallow XISL use before enabling Lossless.
SEE ALSO
aptPolicy, dlsReset, dlsShow, iodReset, iodSet, iodShow, uRouteShow, topologyShow
Fabric OS Command Reference
53-1003108-01
253
2
dlsShow
dlsShow
Displays the setting of the Dynamic Load Sharing (DLS) option.
SYNOPSIS
DESCRIPTION
dlsshow
Use this command to display information about Dynamic Load Sharing configuration settings on the
switch. Depending on the configuration, the command output displays one of the following messages:
•
DLS is set - DLS is enabled without the Lossless feature. Load sharing is reconfigured with every
change in the fabric, and existing routes can be moved to maintain optimal balance. No attempt is
made to prevent frames from being lost while load sharing is recomputed.
•
DLS is not set - DLS is disabled. Existing routes are never moved to maintain optimal balance. If
the Lossless option was enabled before you disabled DLS, it is now disabled as well. This means,
frame loss is not prevented during a load sharing recomputation.
•
DLS is set with Lossless enabled - DLS is enabled with the Lossless feature. Load sharing is
recomputed with every change in the fabric, and existing routes can be moved to maintain optimal
balance. In Lossless mode, no framers are lost during this operation.
•
DLS is set by default with current routing policy. DLS is set with Lossless enabled - Indicates
that the current routing policy (Exchange-based) requires DLS to be enabled by default. In addition,
the Lossless option is enabled. Frame loss is prevented during a load sharing recomputation.
Refer to dlsSet for a description of load sharing.
NOTES
The Lossless feature is not supported on GbE ports and FCoE ports. On unsupported platforms, this
command exits with an appropriate message.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the current DLS configuration on a switch with port-based routing. :
switch:admin> dlsshow
DLS is set with Lossless enabled.
SEE ALSO
254
dlsSet, dlsReset
Fabric OS Command Reference
53-1003108-01
dnsConfig
2
dnsConfig
Sets, displays, or removes domain name service (DNS) parameters.
SYNOPSIS
dnsconfig
dnsconfig --add -domain name -serverip1 ipaddr serverip2 ipaddr
dnsconfig --delete
dnsconfig --show
dnsconfig --help
DESCRIPTION
Use this command to display, set, or remove the domain name service parameters.
The domain name service parameters are the domain name and the name server IP address for primary
and secondary name servers. The dnsconfig command displays IPv4 and IPv6 addresses.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--add
Sets the DNS configuration.
-domain name
Specifies the DNS domain name.
-serverip1 ipaddr
Specifies the DNS primary server IP address. The IP address can be an IPv4 or
IPv6 address.
-serverip2 ipaddr
Specifies the DNS secondary server IP address. The IP address can be an IPv4
or IPv6 address.
--delete
Removes the DNS configurations.
--show
Displays the current DNS configuration.
--help
Displays the command usage.
EXAMPLES
To set the DNS parameters for the system:
switch:admin> dnsconfig
Enter option
1 Display Domain Name Service (DNS) configuration
2 Set DNS configuration
3 Remove DNS configuration
4 Quit
Select an item: (1..4) [4] 2
Enter Domain Name: [] domain.com
Fabric OS Command Reference
53-1003108-01
255
2
dnsConfig
Enter Name Server IP address in dot notation: [] \
123.123.123.123
Enter Name Server IP address in dot notation: [] \
123.123.123.124
DNS parameters saved successfully
Enter option
1 Display Domain Name Service (DNS) configuration
2 Set DNS configuration
3 Remove DNS configuration
4 Quit
Select an item: (1..4) [4] 4
To configure the DNS domain name, DNS server address:
switch:admin> dnsconfig --add -domain www.cp0.com \
serverip1 192.168.1.1 serverip2 192.168.201.1
DNS parameters saved successfully.
To delete the DNS configurations:
switch:admin> dnsconfig --delete
DNS parameters removed successfully.
To display the DNS configurations:
switch:admin> dnsconfig --show
Domain Name Server Configuration Information
__________________________________________
Domain Name
= www.cp0.com
Name Server IP Address = 192.168.1.1
Name Server IP Address = 192.168.201.1
SEE ALSO
256
configDownload, configUpload, firmwareDownload, ipAddrSet, ipAddrShow
Fabric OS Command Reference
53-1003108-01
enclosureShow
2
enclosureShow
Displays attributes of the switch enclosure.
SYNOPSIS
DESCRIPTION
enclosureshow attribute
Use this command to display attributes of the switch enclosure, including the vendor-specific enclosure
identifier and the identifier of the enclosure interface to which the switch is attached.
This command applies to products that are embedded in a blade server or storage chassis. Most options
are platform-specific. Options that do not apply to a platform are identified with a "Not supported on this
platform" message.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
attribute
Specifies the enclosure attribute. Valid attributes include the following:
id
The vendor-specific enclosure identifier.
modelname
The vendor-specific enclosure model name.
slotid
The identifier of the enclosure interface to which the switch is attached.
rackname
The name assigned by the enclosure manager to the rack.
rackid
The serial number assigned by the enclosure manager to the rack.
enclosurename
The name assigned by the enclosure manager to the enclosure.
enclosureid
The serial number assigned by the enclosure manager to the enclosure.
connname
The product name used by the enclosure manager for the switch model.
connaddr
The connector address used by the enclosure manager for this switch (indicates
the physical position of the switch in the enclosure).
connid
The serial number of the switch used by the enclosure manager (not to be
confused with the Factory Serial Number).
conntype
The connector type used by the enclosure manager for this model of switch.
connloc
The switch location within the enclosure.
connpres
Information about the presence of the switch that is used by the enclosure
manager.
Fabric OS Command Reference
53-1003108-01
257
2
enclosureShow
connfuse
Information about whether or not the switch has a fuse.
uuid
The Universal Unique ID for the switch if visible to the enclosure manager.
mmmacaddr
The enclosure manager's Ethernet MAC Address.
snmpports
The SNMP agent and trap ports if visible to the enclosure manager.
EXAMPLES
To display the identifier of the enclosure interface to which the switch is attached:
switch:admin> enclosureShow slotid
Bay 4
SEE ALSO
258
chassisShow
Fabric OS Command Reference
53-1003108-01
errClear
2
errClear
Clears all error log messages for all switch instances on this Control Processor (CP).
SYNOPSIS
DESCRIPTION
NOTES
errclear
Use this command to clear all internal and external error log messages for all switch instances on the CP
where the command is executed. For products with a single processor, all error log messages are
cleared. For products that contain multiple processors, this command can be executed on either control
processor. It clears the error log only on the CP where the command is executed. For example, to clear
the error log on the standby CP, issue errclear on the standby CP.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To clear the error log messages:
switch:admin> errclear
SEE ALSO
errDump, errShow
Fabric OS Command Reference
53-1003108-01
259
2
errDelimiterSet
errDelimiterSet
Sets the error log start and end delimiters for messages sent to the console and syslog.
SYNOPSIS
DESCRIPTION
errdelimiterset
[-s "start_delimiter_string"]
[-e "end_delimiter_string"]
Use this command to set the error log start and end delimiters for log messages sent to the console and
syslog. An empty string clears the start and the end delimiters (including the colon) so that they are not
displayed.
When used without operands, this command displays the existing errDelimiterSet configuration. The
delimiter configuration is stored persistently.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Start and end delimiters are displayed only at the console; they are not displayed in a Telnet session or in
the RASLog.
OPERANDS
This command has the following operands:
-s "start_delimiter_string"
Specifies an alphanumeric string for the start delimiter. The string can be up to 10
characters long and must be enclosed in double quotation marks. This operand is
optional.
-e "end_delimiter_string"
Specifies the alphanumeric string for the end delimiter. The string can be up to 10
characters long and must be enclosed in double quotation marks. This operand is
optional.
EXAMPLES
To display the start and end delimiters:
switch:admin> errdelimiterset
delimiter start string: <none>
delimiter end string: <none>
To change the start and end delimiters (with sample output):
switch:admin> errdelimiterset -s "Start" -e "End"
switch:admin> errdelimiterset
delimiter start string: Start
delimiter end string: End
Sample output:
Start2003/03/10-09:54:03, [NS-1002], 1035,, ERROR,
SWITCH43, Name Server received an invalid request
from device 10:02:32:A3:78:23:23:End
SEE ALSO
260
errDump, errFilterSet, errShow
Fabric OS Command Reference
53-1003108-01
errDump
2
errDump
Displays the error log without pagination.
SYNOPSIS
errdump [--all]
errdump [--count number]
errdump [--reverse]
errdump [--severity severity]
errdump [--slot slotnum]
errdump [--attribute attribute]
errdump [--message msgID]
errdump [--help]
DESCRIPTION
Use this command to dump external error log messages without any page breaks. When executed
without operands, this command prints all error messages for the logical switch context in which the
command is executed.
The output of this command is unique for each control processor (CP). On dual CP systems this
command must be executed on each CP to obtain a complete record.
The following information is displayed in each message:
Start delimiter
Delimiter string for the start of a message.
Timestamp
Timestamp for the message.
Message ID
Message identifier.
External sequence number
Sequence number for the message.
Security audit flag
Security audit message displayed as AUDIT.
Severity
Severity of the message. Valid values include INFO, WARNING, ERROR, and
CRITICAL.
Switch name
Switch name for the generator of this message, or "chassis".
Message
Message body.
End delimiter
Delimiter string for the end of a message.
Fabric OS Command Reference
53-1003108-01
261
2
errDump
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--all
Displays messages for the entire chassis for a user with chassis permissions. This
operand is optional; if omitted, the messages for the current logical switch context
are displayed.
--count number
Displays messages based on count value.
--reverse
Displays messages in reversed order. This operand is optional; if omitted, the
messages display in chronological order.
--severity severity
Displays messages based on severity.
CRITICAL
Displays critical messages.
ERROR
Displays error messages.
WARNING
Displays warning messages.
INFO
Displays informational messages.
--slot slotnum
Displays messages based on slot.
--attribute attribute
Displays messages with the given attribute. Valid attributes values are ALL and
FFDC.
--message msgID
Displays all raslog messages based on the message ID.
--help
Displays command usage.
EXAMPLES
To display the error log for the chassis:
switch:admin> errdump --all
Fabric OS: v7.0.0
2010/12/17-22:29:17, [SEC-1203], 9036, CHASSIS, INFO,\
Spir_67, Login information : Login successful via \
TELNET/SSH/RSH. IP Addr: 10.106.7.62
2010/12/17-22:29:17, [ZONE-1022], 9037, CHASSIS, INFO, \
Spir_67, The effective configuration has changed to meh.
2010/12/17-22:29:17, [FABR-1001], 9041, CHASSIS, WARNING, \
Spir_67, port 0, incompatible Long distance mode.
2010/12/17-22:29:17, [LOG-1000], 9043, CHASSIS, INFO, \
Spir_67, Previous message repeated 1 time(s)
(output truncated)
262
Fabric OS Command Reference
53-1003108-01
errDump
2
To display messages for a slot:
switch:admin> errdump --slot 4
Fabric OS: v7.1.0
2012/06/19-03:26:44, [HAM-1004], 31, SLOT 4 | CHASSIS, INFO, \
pluto_19, Processor rebooted - Reboot.
2012/06/19-03:26:44, [SULB-1003], 32, SLOT 4 | CHASSIS, INFO, \
pluto_19, Firmwarecommit has started.
2012/06/19-03:26:44, [IPAD-1001], 33, SLOT 4 | CHASSIS, INFO, \
pluto_19, CP/1 IPv6 manual fe80::224:38ff:fe1b:4400 DHCP Off.
2012/06/19-03:29:15, [IPAD-1000], 48, SLOT 4 | CHASSIS, INFO, \
pluto_19, CP/0 Ether/0 IPv6 autoconf
fd00:60:69bc:816:205:1eff:fe84:3f49/64 tentative DHCP Off.
2012/06/19-03:29:15, [IPAD-1000], 51, SLOT 4 | CHASSIS, INFO, \
pluto_19, CP/1 Ether/0 IPv6 autoconf
fd00:60:69bc:816:205:1eff:fe84:4aa1/64 tentative DHCP Off.
To display messages based on severity:
switch:admin> errdump --severity WARNING
Fabric OS: v7.1.0
2012/06/18-20:24:52, [SULB-1001], 2, SLOT 5 | CHASSIS, WARNING, \
pluto_19, Firmwaredownload command has started.
2012/06/18-20:36:08, [FSSM-1003], 6, SLOT 5 | CHASSIS, WARNING, \
pluto_19, HA State out of sync.
2012/06/18-20:36:11, [FABR-1001], 8, SLOT 5 | FID 128, WARNING, \
sw0, port 268, ESC detected Fabric ID conflict with neighbor \
(FID 10).
2012/06/18-20:36:11, [FABR-1001], 9, SLOT 5 | FID 128, WARNING, \
sw0, port 281, ESC detected Fabric ID conflict with neighbor \
(FID 20).
2012/06/18-20:36:11, [FABR-1001], 10, SLOT 5 | FID 128, WARNING, \
sw0, port 265, ESC detected Fabric ID conflict with neighbor\
(FID 1).
To display messages based on attributes:
switch:admin> errdump --attribute FFDC
Fabric OS: v7.1.0
2012/06/19-03:58:42, [LOG-1001], 81, SLOT 5 | FFDC | CHASSIS, \
WARNING, pluto_19, A log message was dropped
To display messages based on count value:
switch:admin> errdump --count 3
Fabric OS: v7.1.0
2012/06/18-20:23:09, [LOG-1003], 1, SLOT 5 | CHASSIS, INFO, \
pluto_19, The log has been cleared.
Fabric OS Command Reference
53-1003108-01
263
2
errDump
2012/06/18-20:24:52, [SULB-1001], 2, SLOT 5 | CHASSIS, WARNING, \
pluto_19, Firmwaredownload command has started.
2012/06/18-20:24:52, [SULB-1036], 3, SLOT 5 | CHASSIS, INFO, \
pluto_19, The current Version: Fabric OS v7.1.0
To display raslog messages based on a message ID:
switch:admin> errdump --message SEC-1203
Fabric OS: v7.1.0
2012/11/21-11:06:21, [SEC-1203], 19, FID 128, INFO, switch, \
Login information: Login successful via TELNET/SSH/RSH. \
IP Addr: 10.70.12.104
2012/11/21-12:32:40, [SEC-1203], 20, FID 128, INFO, switch, \
Login information: Login successful via TELNET/SSH/RSH. \
IP Addr: 172.26.1.93
2012/11/22-10:27:41, [SEC-1203], 21, FID 128, INFO, switch, \
Login information: Login successful via TELNET/SSH/RSH. \
IP Addr: 10.70.4.109
SEE ALSO
264
errDelimiterSet, errFilterSet, errShow
Fabric OS Command Reference
53-1003108-01
errFilterSet
2
errFilterSet
Sets a filter for an error log destination.
SYNOPSIS
DESCRIPTION
errfilterset [-d destination][-v severity]
Use this command to set a filter for an error log destination. A filter is set based on the severity level of
the messages.
When used without operands, this command displays the filters that are currently in configured.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-d destination
Specifies the destination for the filter. The string console is the only valid value at
this time.
-v severity
Specifies the minimum severity level of the message to pass through the filter.
Valid values are INFO, WARNING, ERROR, or CRITICAL. Input values are not
case-sensitive.
EXAMPLES
To display the current filter settings:
switch:admin> errfilterset
console: filter severity = WARNING
To set the filter severity level for the console:
switch:admin> errfilterset -d console -v warning
SEE ALSO
errDump, errShow
Fabric OS Command Reference
53-1003108-01
265
2
errModuleShow
errModuleShow
Displays all the defined error log modules.
SYNOPSIS
DESCRIPTION
NOTES
errmoduleshow
Use this command to display a list of all defined error log modules.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display a list of all defined error log modules:
switch:user> errmoduleshow
Module IDs:
1 KT
5 LOG
2 UT
6 CDR
9 PIXE
10 EGR
13 PS
14 RTE
17 BLDE
18 BLM
21 CFLD
22 CFMN
(output truncated)
SEE ALSO
266
3 TRCE
7 BLPU
11
15
19
23
BL
AS
BPRT
CHPS
4 KTRC
8 PISP
12
16
20
24
PIC
AUTH
CER
CONF
errDump, errShow
Fabric OS Command Reference
53-1003108-01
errShow
2
errShow
Displays the error log messages with pagination.
SYNOPSIS
DESCRIPTION
errshow [-a | -r]
Use this command to display external error log messages one at a time. When executed without
operands, this command prints the error messages for the logical switch context in which the command
is executed. When used with the -a option, the command prints the error messages for the entire
chassis. The messages are displayed with page breaks. The -r operand displays the messages in
reversed order.
The output of this command is unique for each Control Processor (CP). On dual CPs this command must
be executed on each CP to obtain a complete record.
The following information displays in each message:
Start delimiter
Delimiter string for the start of a message.
Timestamp
Timestamp for the message.
Message ID
Message identifier.
External sequence number
Sequence number for the message
Security audit flag
Security audit message displayed as AUDIT.
Severity
Severity of the message. Valid values include INFO, WARNING, ERROR, and
CRITICAL.
Switch name
Switch name for the generator of this message, or "chassis".
Message
Message body.
End delimiter
Delimiter string for the end of a message.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-a
Displays messages for the entire chassis for a user with admin and chassis
permissions. This operand is optional; if omitted, the messages for the current
logical switch context are displayed.
-r
Displays messages in reversed order. This operand is optional; if omitted, the
messages display in the chronological order.
Fabric OS Command Reference
53-1003108-01
267
2
errShow
EXAMPLES
To display the error log for the chassis:
switch:admin> errshow -a
Fabric OS: v7.2.0
2013/06/11-10:16:07, [SEC-1203], 261, FID 128, INFO, \
switch, Login information: Login successful via \
TELNET/SSH/RSH. IP Addr: 192.0.2.2
[Type <CR> to continue, Q<CR> to stop:
2013/06/11-10:44:13, [TS-1002], 262, FID 128, INFO, \
switch, External Clock Server used instead of \
LOCL: locl: 0x45585400 remote: 0x4c4f434c.
[Type <CR> to continue, Q<CR> to stop:
2013/06/11-11:00:49, [SNMP-1005], 287, FID 128, INFO, \
switch, SNMP configuration attribute, SNMPv3 Trap \
Recipient IP Address 6, has changed from [192.0.2.10] \
to [0.0.0.0].
[Type <CR> to continue, Q<CR> to stop:
2013/06/11-11:00:49, [SNMP-1005], 288, FID 128, INFO, \
switch, SNMP configuration attribute, SNMPv3 Trap \
Recipient Severity Level 6, has changed from 4 to 0.
[Type <CR> to continue, Q<CR> to stop:
SEE ALSO
268
errDelimiterSet, errDump, errFilterSet
Fabric OS Command Reference
53-1003108-01
exit
2
exit
DESCRIPTION
SEE ALSO
See logout.
None
Fabric OS Command Reference
53-1003108-01
269
2
fabRetryShow
fabRetryShow
Displays the retry count of the fabric commands.
SYNOPSIS
DESCRIPTION
fabretryshow
Use this command to display the retry count of the fabric commands. For each port, the command output
displays counts for the following Switch Internal Link Service (SW_ILS) requests:
ELP
Exchange Link Parameters
EFP
Exchange Fabric Parameters
HA_EFP
Exchange Fabric Parameters used during warm recovery
DIA
Domain Identifier Assigned
RDI
Request Domain Identifier
BF
Build Fabric
FWD
Fabric Controller Forward
EMT
Fabric Controller Mark Timestamp
ETP
Fabric Controller Trunk Parameters
RAID
Return Address Identifier
GAID
Get Address Identifier
ELP_TMR
Used internally for fabric application (not a SW_ISL)
GRE
Get Route Entry
ECP
Exchange Credit Parameters
ESC
Exchange Switch Capabilities
EFMD
Exchange Fabric Membership Data
ESA
Exchange Security Attributes
DIAG_CMD
Diagnostic Command
270
Fabric OS Command Reference
53-1003108-01
fabRetryShow
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the retry count of Fabric OS Commands:
SEE ALSO
2
switch:user> fabretryshow
SW_ILS
E_Port ELP EFP HA_EFP DIA RDI
BF
FWD
EMT
ETP
RAID \
34
35
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
GAID ELP_TMR GRE
ECP
ESC
EFMD ESA
DIAG_CMD
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
\
\
None
Fabric OS Command Reference
53-1003108-01
271
2
fabRetryStats
fabRetryStats
Displays or manages the retry count of fabric commands.
SYNOPSIS
fabretrystats --show
fabretrystats --clear
fabretrystats --help
DESCRIPTION
Use this command to view and clear the retry count of the fabric commands. The --clear option clears
the counters for all the Switch Internal Link Service (SW_ILS) requests. For each E/D_Port, the --show
option displays the counters for the following Switch Internal Link Service (SW_ILS) requests:
ELP
Exchange Link Parameters
EFP
Exchange Fabric Parameters
HA_EFP
Exchange Fabric Parameters used during warm recovery
DIA
Domain Identifier Assigned
RDI
Request Domain Identifier
BF
Build Fabric
FWD
Fabric Controller Forward
EMT
Fabric Controller Mark Timestamp
ETP
Fabric Controller Trunk Parameters
RAID
Return Address Identifier
GAID
Get Address Identifier
ELP_TMR
Used internally for fabric application (not a SW_ISL)
GRE
Get Route Entry
ECP
Exchange Credit Parameters
ESC
Exchange Switch Capabilities
EFMD
Exchange Fabric Membership Data
ESA
Exchange Security Attributes
272
Fabric OS Command Reference
53-1003108-01
fabRetryStats
2
DIAG_CMD
Diagnostic Command
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--show
Displays the retry count of fabric commands for all E_Ports and D_Ports.
--clear
Clears the retry count of fabric commands.
--help
Displays the command usage.
EXAMPLES
To display the retry count of fabric commands:
switch:admin> fabretrystats --show
SW_ILS
-----------------------------------------------------------\
E/D_Port
ELP
EFP
HA_EFP DIA
RDI
BF
FWD
EMT \
-----------------------------------------------------------------------\
3
12
ETP
0
0
1
0
RAID
0
0
0
2
GAID
0
0
0
0
ELP_TMR
0
0
0
0
GRE
0
0
0
0
0
0
ECP
0
0
0
0
ESC
0
0
EFMD
0
0
0 \
0 \
ESA
0
0
DIAG_CMD
0
0
To clear the retry count of fabric commands:
switch:admin> fabretrystats --clear
switch:admin> fabretrystats --show
SW_ILS
-----------------------------------------------------------\
E/D_Port
ELP
EFP
HA_EFP DIA
RDI
BF
FWD
EMT \
-----------------------------------------------------------------------\
3
0
0
0
0
0
0
0
0 \
12
0
0
0
0
0
0
0
0 \
ETP
RAID GAID ELP_TMR
GRE
ECP
ESC
EFMD ESA
DIAG_CMD
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
SEE ALSO
fabRetryShow, fabStatsShow
Fabric OS Command Reference
53-1003108-01
273
2
fabricLog
fabricLog
Displays (all users) or manipulates (admin) the fabric log.
SYNOPSIS
fabriclog -s | --show [dport]
fabriclog -c | --clear [dport]
fabriclog -d | --disable
fabriclog -e | --enable
fabriclog -r size | --resize size
fabriclog -h | --help
DESCRIPTION
Use this command to display, clear, disable, enable, or resize the fabric log. When used with the --show
option, this command displays the following information:
Time Stamp
Time of the event in the following format HH:MM:SS:MS.
Input and *Action
Fabric log message. An asterisk (*) in the message indicates an action. The link
reset information is indicated by LR_IN and LR_OUT. LR_IN indicates a link reset
on the remote switch, whereas LR_OUT indicates a link reset on the local switch.
S
Current switch state. Valid switch states include the following:
FO
Build Fabric (BF) received.
F1
Reconfigure Fabric (RCF) is not supported.
F2
Exchange Fabric Parameters (EFP) is waiting for last Accept Frame (ACC) from
flood.
F3
Flood EFPs.
D0
The switch is the principal switch.
D1
The principal switch is sending Domain ID Assigned (DIA).
D2
The principal switch is waiting for Request Domain ID (RDI).
D3
The principle switch is processing the RDI.
A0
The switch is not the principal switch.
A1
The non-principal switch is sending a DIA.
A2
The non-principal switch is waiting for an RDI.
274
Fabric OS Command Reference
53-1003108-01
fabricLog
2
A3
The non-Principal switch is processing an RDI.
S0
The switch is in offline state.
P
Port state. Port states include the following:
PO
The port is offline.
P1
The port is online.
P2
Exchange Link Parameters (ELP) Accept Frame (ACC) received.
P3
Link reset occurred on master or E_Port.
I0
Trunk Initiator: Exchange Mark Timestamp (EMT) sent.
I1
Trunk Initiator: Exchange Trunking Parameters (ETP) Accept Frame (ACC)
received.
I2
Trunk Initiator: ETP sent.
I3
Trunk Initiator: Link reset occurred.
I4
Trunk Initiator: Link reset done on slave.
T0
Trunk Target: EMT received.
T1
Trunk Target: ETP received.
T2
Trunk Target: Link reset.
T3
Trunk Target: Link reset done on slave.
LD
Dynamic long distance ECP sent or received.
ESC
Exchange Switch Capabilities (ESC) state between P2 and P3.
Sn
Next switch state. Refer to switch states for valid states.
Pn
Next port state. Refer to port states for valid states.
Port
Port number, if applicable, or NA
Xid
OXID (Exchange ID) Port number, if applicable, or NA
Refer to the FC-SW-5 specification for more information on the port and switch states logged by this
command.
Fabric OS Command Reference
53-1003108-01
275
2
fabricLog
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-s | --show [dport]
Displays the fabric log. Optionally displays the D_Port logs only.
-c | --clear [dport]
Clears the fabric log. Optionally clears the D_Port logs only.
-d | --disable
Disables the fabric log. By default, the fabric log is enabled.
-e | --enable
Enables the fabric log.
-r size | --resize size
Changes the maximum number of log entries. The specified size must be at least
2 and a power of 2; otherwise, the command fails. The default size is 1024 or
more depending on the port count of the switch.
-h | --help
Displays the command usage.
EXAMPLES
To display the fabric log:
switch:admin> fabriclog -s
Time Stamp
Input and *Action
S, P
Sn,Pn Port
Xid
=============================================================================
======
Switch 0; Thu Feb 23 06:55:59 2012 GMT (GMT+0:00)
06:55:59.661357 *Fss Init
NA,NA NA,NA NA
NA
06:55:59.661606 *Initiate State
NA,NA F2,NA NA
NA
06:55:59.963652 Expd1 0x00000000 0000ffff ffffffff ffffffff F2,NA F2,NA 0
NA
06:56:03.242214 Rcv FSS_RECOV_COLD
F2,NA F2,NA NA
NA
06:56:03.242264 D-port Offline Skip Cnt 1(inst = 1)
F2,NA F2,NA NA
NA
06:58:44.880675 SCN LR_PORT (0);g=0x22; LR_IN
A2,P0 A2,P0 41
NA
07:00:12.107354 D-port Offline Skip Cnt 1(inst = 4)
F2,NA F2,NA NA
NA
07:00:12.640790 SCN LR_PORT (0);g=0x0; LR_OUT
F2,P0 F2,P0 11
NA
07:00:12.772930 SCN Port Online;g=0x0;
F2,P0 F2,P1 11
NA
(output truncated)
To change the size of the fabric log:
switch:admin> fabriclog -r 64
Warning: This command will clear the logs.
Are you sure you want to do the resize [y/n]? y
276
Fabric OS Command Reference
53-1003108-01
fabricLog
2
To display the cleared fabric log after the size was changed:
switch:admin> fabriclog -s
Time Stamp Input and *Action
S, P
Sn,Pn Port Xid
========================================================
Number of entries: 0
Max number of entries: 64
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
277
2
fabricName
fabricName
Configures the fabric name parameter.
SYNOPSIS
fabricname --set fabric_name
fabricname --clear
fabricname --show
fabricname --help
DESCRIPTION
Use this command to configure a name for the fabric.
With Virtual Fabrics it is not uncommon to have multiple fabrics in a single chassis. These logical fabrics
are identified by their Fabric ID. With the fabricName command, you can address a fabric by name. This
command provides an option for addressing fabrics by name. However, the fabric name does not replace
the FID; the functionality of the FID is unaffected by the fabric name.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Fabric name support requires Fabric OS v7.0.0 firmware and will be lost on downgrade.
OPERANDS
This command has the following operands:
--set fabric_name
Sets the fabric name. The fabric name is a unique character string and can be up
to 128 characters long. You can use any character including spaces and
meta-characters. A fabric name that includes spaces must be included in double
quotation marks. Tabs are not permitted. By default, the fabric name is not
configured.
--clear
Clears the fabric name.
--show
Displays the fabric name. If a fabric name is not configured, an appropriate
message is displayed.
--help
Displays the command usage.
EXAMPLES
To set and display the fabric name:
switch:user> fabricname --show
Fabric Name is not configured
switch:user> fabricname --set myfabric@1
Fabric Name set to "myfabric@1"
switch:user> fabricname --show
Fabric Name: "myfabric@1"
To set a fabric name that includes spaces:
switch:user> fabricname --set "my new fabric"
Fabric Name set to "my new fabric"
278
Fabric OS Command Reference
53-1003108-01
fabricName
2
switch:user> fabricname --show
Fabric Name: "my new fabric"
To clear the fabric name:
switch:user> fabricname --clear
Fabric Name cleared!
switch:user> fabricname --show
Fabric Name is not configured
SEE ALSO
switchShow, fabricShow
Fabric OS Command Reference
53-1003108-01
279
2
fabricPrincipal
fabricPrincipal
Sets the principal switch selection mode.
SYNOPSIS
fabricprincipal --help | -h
fabricprincipal [--show | -q]
fabricprincipal --enable
[ -priority | -p priority]
[-force | -f ]
fabricprincipal --disable
fabricprincipal [-f] mode
DESCRIPTION
Use this command to set principal switch selection mode for a switch and to set priorities for principal
switch selection.
The implementation of the fabricPrincipal command is based solely on mechanisms specified in the
Fibre Channel standards. These mechanisms provide a preference for a switch requesting to be the
principal switch in a fabric, but they do not provide an absolute guarantee that a switch requesting to be
the principal switch is granted this status.
When dealing with large fabrics, the selection of the principal switch is less deterministic. In these cases,
to help ensure that the desired switch is selected as the principal switch, a small cluster of switches
should be interconnected first, followed by additional switches to enlarge the fabric.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--help |-h
Displays the command usage.
--show
Displays the current mode setting and principal switch selection priority. This
operand is optional; if not specified, fabricPrincipal displays the same data as
with the --show option.
-q
Displays principal mode only (enabled or disabled). This is a legacy command
option that does not display the priority settings.
--enable
Enables principal switch selection. The following operands are optional. If you do
not provide a priority value, the system assigns the default of 0x01 or generates a
value based on the switch state.
-priority | -p priority
Sets the principal selection priority of the switch. The specified priority value is
used in the principal switch selection protocol when the fabric rebuilds. Not all of
these values can be assigned.
0x00
Reserved. This value cannot be assigned.
280
Fabric OS Command Reference
53-1003108-01
fabricPrincipal
2
0x01
Highest priority. This is a user-defined value
0x02
Switch was principal prior to sending or receiving a build fabric (BF) request.
This value is generated by the switch to initiate a fabric reconfiguration. This
value should not be assigned.
0x3 - 0xFE
Priority value range. Choose a value in this range to indicate priority. Higher
numbers mean lower priority.
0xFF
Switch is not capable of acting as a principal switch. This is a user-defined
value. Use --enable with a new priority to revert to this condition.
-force | -f
Forces a fabric rebuild regardless of whether the switch is principal or
subordinate. This option is not valid with the --disable command.
--disable
Disables principal switch selection. This command resets the priority to the default
value 0xFE.
[-f] mode
Sets the principal switch selection mode. Specify 1 to enable principal switch
selection mode. Specify 0 to disable principal switch selection mode. Optionally,
use the -f operand to force a fabric rebuild. Mode changes take effect when the
fabric rebuilds. This operand is optional.
EXAMPLES
To enable a high fabric principal priority setting:
switch:admin> fabricprincipal --enable -p 0xff
Principal Selection Mode enabled (Activate in \
next fabric rebuild)
To disable the principal mode selection:
switch:admin> fabricprincipal --disable
Principal Selection Mode disabled
To display the current mode setting:
switch:admin> fabricprincipal -q
Principal Selection Mode: Enable
To disable the mode setting:
switch:admin> fabricprincipal 0
Principal Selection Mode disabled
To enable the mode setting:
switch:admin> fabricprincipal 1
Principal Selection Mode enabled
To enable the mode setting and force fabric rebuild:
switch:admin> fabricprincipal -f 1
Principal Selection Mode enabled \
(Forcing fabric rebuild)
Fabric OS Command Reference
53-1003108-01
281
2
fabricPrincipal
To display the principal switch selection priority:
switch:admin> fabricprincipal --show
Principal Selection Mode: Enable
Principal Switch Selection Priority: 0x10
SEE ALSO
282
fabricShow
Fabric OS Command Reference
53-1003108-01
fabricShow
2
fabricShow
Displays fabric membership information.
SYNOPSIS
fabricshow [-membership | -chassis | -paths]
fabricshow -help
DESCRIPTION
Use this command to display information about switches in the fabric.
If the switch is initializing or is disabled, the message "no fabric" is displayed.
Running this command on an FCR or edge switch does not provide any router information; running this
command on an edge switch with the -membership option does provide router information.
If the fabric is reconfiguring, some or all switches may not be displayed; otherwise, the following fields
are displayed depending on the command option used:
Switch ID
The switch Domain_ID and embedded port D_ID.
Worldwide Name
The switch WWN.
Enet IP Addr
The switch Ethernet IP address for IPv4- and IPv6-configured switches. For IPv6
switches, only the static IP address displays.
FC IP Addr
The switch FC IP address.
Name
The switch symbolic name. An arrow (>) indicates the principal switch.
FC Router IP Addr
The IP address of the FC Router. This field is empty if the switch is not an FC
Router or it the FC Router does not support it.
FC Router Name
The FC Router symbolic name. This field is empty if the switch is not an FC
Router or it the FC Router does not support it.
Chassis WWN
The world wide name of the chassis. For switches running firmware versions that
do not distribute the chassis WWN, this field displays "NA".
Chassis Name
The name of the chassis. For switches running firmware versions that do not
distribute the chassis name, this field displays "NA".
Fabric Name
If the fabric has an assigned name, the fabric name is displayed at the end of the
command output.
Path Count
The number of currently available paths to the remote domain.
Fabric OS Command Reference
53-1003108-01
283
2
fabricShow
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-membership
Displays fabric membership information with additional details of the FC Router, if
present in the fabric.
-chassis
Displays information about the chassis including chassis WWN and chassis
name.
-paths
Displays the number of paths available to each remote domain.
-help
Displays the command usage.
EXAMPLES
The following example illustrates a fabric of four switches. The switch named "sw180" is the Principal
switch. Three of the switches are configured to run IP over Fibre Channel. The fabric name is configured.
switch:admin> fabricshow
Switch ID
Worldwide Name
Enet IP Addr
FC IP Addr
Name
---------------------------------------------------------------------64:fffc40 10:00:00:60:69:00:06:56 192.168.64.59 192.168.65.59
"sw5"
65:fffc41 10:00:00:60:69:00:02:0b 192.168.64.180 192.168.65.180>"sw180"
66:fffc42 10:00:00:60:69:00:05:91 192.168.64.60 192.168.65.60
67:fffc43 10:00:00:60:69:10:60:1f 192.168.64.187 0.0.0.0
"sw60"
"sw187"
The Fabric has 4 switches
Fabric Name: mainFabricA
To show a mixed fabric with IPv4- and IPv6-configured switches (the fabric name is not configured):
switch:admin> fabricshow
Switch ID Worldwide Name
Enet IP Addr
FC IP Addr
Name
---------------------------------------------------------------------1:fffc41 10:00:00:60:69:00:02:0b 192.168.64.180 192.168.65.180>"sw180"
1080::8:800:200C:1234/64
2:fffc42 10:00:00:60:69:00:05:91 192.168.64.60 192.168.65.60 "sw60"
The Fabric has 2 switches.
To show additional details of the FC Router, if present:
switch:admin> fabricshow -membership
Switch ID
Name
ENET IP Addr
FC Router
FC Router
IP Addr
Name
-----------------------------------------------------------------1: fffc01 fcr_sprint_01 10.33.59.224
160: fffca0 fcr_fd_160
0.0.0.0
10.33.59.25 fcr_meteor2
190: fffcbe fcr_mojo_6
10.33.59.32
The Fabric has 3 switches
284
Fabric OS Command Reference
53-1003108-01
fabricShow
2
To show additional details about the chassis:
switch:admin> fabricshow -chassis
Switch ID
Name
ENET IP Addr Chassis WWN
Chassis Name
--------------------------------------------------------------------4:fffc04 sw5100_126_128 10.38.17.126 10:00:00:05:1e:0e:eb:58 Brcd5100
5:fffc05 sw1500_127_128 10.38.17.127 10:00:00:05:1e:0e:eb:98 Brcd5100
The Fabric has 2 switches
To show additional details about the paths:
switch:admin> fabricshow -paths
Switch ID
Name
ENET IP Addr Worldwide Name
Path Count
-------------------------------------------------------------------28: fffcb2 DCX_28 192.0.2.28
10:00:00:05:1e:e5:ab:00 N/A
38: fffcbc DCX_38 192.0.2.38
10:00:00:05:1e:47:cb:00 9
The Fabric has 2 switches
SEE ALSO
fabricName, switchShow
Fabric OS Command Reference
53-1003108-01
285
2
fabStatsShow
fabStatsShow
Displays fabric statistics.
SYNOPSIS
DESCRIPTION
fabstatsshow
Use this command to display statistics for the fabric. The following information is displayed:
•
•
•
•
Number of times a switch domain ID has been forcibly changed
Number of E_Port offline transitions
Number of fabric reconfigurations
Number of fabric segmentations resulting from any of the following causes:
-
Loopback
Incompatibility
Overlap
Zoning
E_Port segment
Licensing
Disabled E_Port
Platform DB
Security incompatibility
Security violation
ECP error
Duplicate WWN
E_Port isolated
Admin Domain header conflict
Virtual Fabric Admin Domain conflict
MSFR/RD H&T WWN conflict (internal only)
Enhanced/Overlapping TI zones (ETIZ) Incompatibility
Exchange Switch Capabilities (ESC) detected conflict
Encryption conflict - Both ends are not configured for encryption
Compression conflict - Both ends are not configured for encryption
Encryp/Comp bw availability - Encryption or compression - Configured but lack of bandwidth in
the ASIC
For each recorded incident, the command provides the following additional information:
Count
The total number of times the specific event occurred on various ports on the
switch.
Port
The number of the port where the latest incident occurred. An arrow (<) next to the
port number denotes the type of event that occurred last.
Timestamp
The time when the latest incident occurred.
286
Fabric OS Command Reference
53-1003108-01
fabStatsShow
NOTES
2
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the fabric statistics:
switch:admin> fabstatsshow
Description
Count
Port
Timestamp
--------------------------- ------ ------ ---------------Domain ID forcibly changed:
0
E_Port offline transitions:
0
Reconfigurations:
2 0 Sat Dec 18 14:29:56 2010
Segmentations due to:
Loopback:
0
Incompatibility:
0
Overlap:
0
Zoning:
0
E_Port Segment:
0
Licensing:
0
Disabled E_Port:
0
Platform DB:
0
Sec Incompatibility:
0
Sec Violation:
0
ECP Error:
0
Duplicate WWN:
0
Eport Isolated:
0
AD header conflict:
0
VF AD conflict:
0
MSFR/RD H&T WWN conflict:
0
ETIZ Incompatibility:
0
ESC detected conflict:
0
Encryption conflict:
0
Compression conflict:
0 < 349 Wed Oct 27 15:33:58 2010
Encryp/Comp bw availability:
0
'<' - Denotes the type of event that occurred last.
SEE ALSO
fabRetryShow
Fabric OS Command Reference
53-1003108-01
287
2
fanDisable
fanDisable
Disables a fan unit.
SYNOPSIS
DESCRIPTION
NOTES
fandisable unit
Use this command to disable a nonfaulty fan unit by setting the RPM speed to 0.
This command is not available on nonbladed systems except for the Brocade 5300.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
unit
Specifies the number of the fan unit to disable.
EXAMPLES
To disable a fan unit:
switch:admin> fandisable 1
Fan unit 1 has been disabled
SEE ALSO
288
fanEnable, fanShow
Fabric OS Command Reference
53-1003108-01
fanEnable
2
fanEnable
Enables a fan unit.
SYNOPSIS
DESCRIPTION
NOTES
fanenable unit
Use this command to set a previously disabled fan unit back to the default RPM speed.
This command is not available on nonbladed systems except for the Brocade 5300.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
unit
Specify the fan unit number to enable.
EXAMPLES
To enable a fan unit:
switch:admin> fanenable 1
Fan unit 1 has been enabled
SEE ALSO
fanDisable, fanShow
Fabric OS Command Reference
53-1003108-01
289
2
fanShow
fanShow
Displays fan status and speed.
SYNOPSIS
DESCRIPTION
fanshow
Use this command to display the current status and speed of each fan in the system.
Fan status is displayed as follows:
OK
Fan is functioning correctly.
absent
Fan is not present.
below minimum
Fan is present but rotating too slowly or stopped.
above minimum
Fan is rotating too quickly.
unknown
Unknown fan unit installed.
faulty
Fan has exceeded hardware tolerance and has stopped. In this case, the last
known fan speed is displayed.
The output from this command varies depending on switch type and number of fans present.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display information on the fans in the system:
switch:admin>
Fan #1 is OK,
Fan #2 is OK,
Fan #3 is OK,
SEE ALSO
290
fanshow
speed is 2721 RPM
speed is 2657 RPM
speed is 2700 RPM
chassisShow, fanDisable, fanEnable, psShow
Fabric OS Command Reference
53-1003108-01
faPwwn
2
faPwwn
Manages fabric-assigned port world wide names.
SYNOPSIS
fapwwn --enable -port [slot/]port[-port]
fapwwn --enable -ag AG_WWN] -port port
fapwwn --disable -port [slot/]port[-port]
fapwwn --disable -ag AG_WWN -port port
fapwwn --assign [-ag AG_WWN] -port [slot/]port [-v VPWWN]
fapwwn --delete -port [slot/]port[-port]
fapwwn --delete -ag AG_WWN [-port port]
fapwwn --delete -v VWWN
fapwwn --move -srcport source_port -dstport dest_port
fapwwn --move -srcag AG_WWN -srcport source_port
-dstag AG_WWN -dstport dest_port
fapwwn --show [-port | -ag ] all
fapwwn --show -port [slot/]port[-port]
fapwwn --show -ag AG_WWN [-port]
fapwwn --help
DESCRIPTION
Use this command to create and manage fabric-assigned port world wide names (FA-PPWWNs) for
Dynamic Fabric Provisioning (DFP). A FA-PWWN is a "virtual" port WWN that will bind to a device port
and can be later assigned to a physical device. A FA-PWWN can be either user-generated or
automatically assigned by the fabric. The automatically assigned FA-PWWN is created by default when
you enable the feature without explicitly providing a VPWWN. With FA-PWWNs assigned to FC ports or
Access Gateway (AG) ports, you can provision the ports in advance with zoning configurations, access
control, or Ports on Demand assignments, and you can easily move servers across ports or Access
Gateways by way of reassigning the FA-PWWN to another port.
The fapwwn command supports the following management tasks:
•
•
•
•
•
•
•
Bind an automatically assigned or a user-assigned FA-PWWN to a switch port.
Override an automatically assigned FA-PWWN with a user-assigned FA-PWWN.
Bind an AG port with an automatically assigned or a user-assigned FA-PWWN.
Delete any existing FA-PWWN bindings.
Move a FA-PWWN from one port to another port.
Move a FA-PWWN assigned to an AG port to another AG.
Display information about configured FA-PWWN bindings.
Fabric OS Command Reference
53-1003108-01
291
2
faPwwn
A single port can be assigned up to two WWNs, one assigned automatically and one assigned by the
user. Only one FA-PWWN can be active at any given time. The user-assigned FA-PWWN takes
precedence over the automatically assigned FA-PWWN. This means, the switch will bind the
user-assigned FA-PWWN to the port if both a user-assigned and an automatically assigned FA-PWWN
are available.
FA-PWWN configurations are saved persistently and are preserved even if the feature is disabled on a
port, or if you move the port to a different logical switch. The same configuration will be reapplied on the
port once the feature is enabled or the port is moved back to the switch where you initially created and
saved the configuration.
When issued for switch ports, the --show option displays the following information:
Port
Port number
PPWNN
Real PWWN of the device
VPWNN
Currently active FA-PWWN.
The following information is displayed for Access Gateway ports:
AG Port
Access Gateway node WWN followed by a slash and port number
Port
The FC switch port number
Device Port WWN
The real device port WWN displays only if the device is logged into the Access
Gateway.
Virtual Port WWN
The FA-PWWN (user-assigned or automatically assigned) created on the FC
switch for the Access Gateway port.
The following information is displayed for both AG and FC switch ports:
PID
Port ID.
Enable
Displays "yes" if the configuration is enabled; displays "No" if the configuration is
disabled.
MapType
Displays the type of mapping: Access Gateway (AG) or switch port (port),
user-assigned (user) or automatically assigned (auto).
NOTES
This command is supported only on the Brocade DCX, DCX-4S, DCX 8510-4, DCX 8510-8,and the and
Brocade 6510. Regarding Access Gateway support, you cannot configure FA-PWWN on the Brocade
300, and 5100 when these switches are in Access Gateway mode. The AG port must be configured on
the switch to which the AG is connected. However, both AG switches are FA-PWWN-aware, which
means that they can connect to switches with configured FA-PWWN ports. Refer to the Brocade
Adapters Administrator's Guide for list of supported Host Bus Adapters (HBAs) and configuration
procedures. Refer to the Release Notes for other restrictions that may apply.
You cannot enable the FA-PWWN feature if portSwap is enabled on the ports.
The operands, --assign, --delete, --enable, and --disable can be executed only on a disabled port
(switch ports and AG ports). You must re-enable the ports to come online with the new configuration.
292
Fabric OS Command Reference
53-1003108-01
faPwwn
2
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
this command has the following operands:
--enable
Enables the FA-PWWN feature on the specified switch ports or AG ports. If a
FA-PWWN is not available for the ports, this command automatically assigners
FA-PWWNs to the ports.
--disable
Disables the FA-PWWN feature on the specified switch ports or AG ports. This
commands disables the binding of any existing FA-PWWNs to the specified ports,
it does not delete the port configurations themselves. When you re-enable the
feature, the persistently saved configurations are re-applied to the ports.
--assign
Assigns a FA-PWWN to a specified port. You can specify only a single port with
this command (not a port range) and optionally provide a VPWWN. When
executed without the -v option, this command automatically generates a
FA-PWWN and assigns it to the port. When executed with the -v option, and a
user-assigned FA-PWWN already exists, this command fails with an appropriate
message. If an automatically assigned FA-PWWN exists, the user-generated
FA-PWWN overrides the automatically generated FA-PWWN. When you assign a
FA-PWWN to an AG port, you must specify the AG node WWN to uniquely identify
the AG. The new FA-PWWN will take effect upon the next login session.
--delete
Deletes the active FA-PWWN from the specified ports. If a port is bound to a
user-assigned FA-PWWN, this command deletes the currently active FA-PWWN
and activates the automatically assigned FA-PWNN. If the active FA-PWWN is
automatically assigned and no user-assigned FA-PWWN exists, this command
deletes the FA-PWWN. When deleting VPWWNs from an AG, you must specify
the AG node WWN and the -port operand is optional; if omitted, all active
FA-PWWNs are deleted from the AG. To delete a single FA-PWWN, use the
delete command with the -v option.
If no active FA-PWWNs exist on the ports, the FA-PWWN feature is disabled. Use
the -enable command to re-enable the feature.
--show
Displays the FA-PWWN configuration for the specified ports or for all ports in the
logical switch. When displaying information for AG ports, you must specify the AG
node WWN.
-port[slot/]port[-port]
Specifies the ports to be configured or displayed on the switch or on the AG,
preceded by a slot number on bladed systems. The port list can include a single
port or a port range, for example, 3-5 or 1/3-5. Port ranges are supported only with
automatically assigned FA-PWWNs, and only on switch ports. You cannot use a
port range on AG ports.
-ag AG_WWN
Specifies the Access Gateway node WWN.
-v VPWWN
Specifies a virtual PWWN to be assigned to the port. This operation deactivates
any existing FA-PWWN on the port.
Fabric OS Command Reference
53-1003108-01
293
2
faPwwn
all
Specifies all ports on the logical switch. This operand is valid only with the --show
option.
--move
Moves an active FA-PWWN from a source to the specified destination port. Use
this command to move a server across switch ports. If the source port has both a
user-assigned and an automatically assigned FA-PWWN, the user-assigned
FA-PWWN will be moved to the destination port as a user-assigned FA-PWWN
and replace any automatically assigned FA-PWWN that may be active on that
port. If the source port has only an auto-assigned FA-PWWN, the auto-assigned
FA-PWWN will be moved to the destination port and the FA-PWWN feature will be
disabled on the source port, because there is no FA-PWWN left on that port.
When moving PWWNs between Access Gateways, you must specify the source
AG node WWN and the destination AG node WWN in addition to the ports.
The following operands are supported with the --move option:
-srcag AG_WWN
Specifies the source AG by its node WWN. This operand is required only when
moving ports between Access Gateways.
-dstag AG_WWN
Specifies the destination AG by its node WWN. This operand is required only
when moving ports between Access Gateways.
-srcport source_port
Specifies the port from which to move the PWWN.
-dstport dest_port
Specifies the destination port for the moved PWWN.
--help
Displays the command usage.
EXAMPLES
To enable the FA-PWWN feature on a switch port:
switch:admin> fapwwn --enable -port 10
To disable the FA-PWWN feature on the switch port:
switch:admin> fapwwn --disable -port 10
To move the active FA-PWWN from a source port to another port:
switch:admin> fapwwn --move -srcport 2 -dstport 3
To move the active FA-PWWN from a source AG port to a destination AG port:
switch:admin> fapwwn --move -srcag 11:11:11:11:11:11:11:11 \
-srcport 12 -dstag 22:22:22:22:22:22:22:22 -dstport 14
To assign a user-assigned FA-PWWN to a switch port:
fapwwn --assign -port 1/10 -v
50:60:70:71:72:73:81:81
To assign an automatically assigned FA-PWWN to a switch port:
fapwwn --assign -port 1/10
To assign a fabric-assigned FA-PWWN to an AG port identified by the AG node WWNN and port number:
fapwwn --assign -ag 12:34:56:78:90:12:23:45 -port 0
294
Fabric OS Command Reference
53-1003108-01
faPwwn
2
To assign an user-assigned FA-PWWN to an AG port:
fapwwn --assign -ag 12:34:56:78:90:12:23:45 -port 0 \
-v 11:22:33:44:55:66:77:88
To delete the active FA-PWWN of a switch port:
fapwwn --delete -port 10
To delete the active FA-PWWN of an AG port:
fapwwn --delete -ag 12:34:56:78:90:12:34:56 -port 10
To display the active FA-PWWN for a single FC port (the real device PWWN is hidden):
fapwwn --show -port 10
----------------------------------------------------------------------Port
PPWWN
VPWWN
PID Enable MapType
----------------------------------------------------------------------10 --:--:--:--:--:--:--:-- 52:00:10:00:00:0f:50:45 -- Yes Port/Auto
To display the active FA-PWWNs for all FC switch ports:
fapwwn --show -port all
----------------------------------------------------------------------Port
PPWWN
VPWWN
PID Enable MapType
----------------------------------------------------------------------0 --:--:--:--:--:--:--:-- 52:00:10:00:00:0f:50:30 10101 Yes Port/Auto
1 --:--:--:--:--:--:--:-- 11:22:33:44:33:22:11:22 -Yes Port/User
52:00:10:00:00:0f:50:44
10 --:--:--:--:--:--:--:-- 52:00:10:00:00:0f:50:45 -- Yes Port/Auto
To display the active FA-PWWN of an AG port :
fapwwn --show -ag 10:00:00:05:1e:d7:3d:dc -port 8
----------------------------------------------------------AG Port
Port
Device Port WWN
\
----------------------------------------------------------10:00:00:05:1e:d7:3d:dc/8
20
20:08:00:05:1e:d7:2b:74 \
-----------------------------------------------------------Virtual Port WWN
PID
Enable MapType
-----------------------------------------------------------11:22:33:44:55:66:77:88
11403
Yes
AG/User
52:00:10:00:00:0f:50:32
(output split)
To display the active FA-PWWNs of all configured AG ports:
fapwwn --show -ag all
----------------------------------------------------------AG Port
Port
Device Port WWN
\
----------------------------------------------------------10:00:00:05:1e:65:8a:d5/16 ---:--:--:--:--:--:--:-- \
10:00:00:05:1e:d7:3d:dc/8
20
20:08:00:05:1e:d7:2b:74 \
\
10:00:00:05:1e:d7:3d:dc/9
20
20:09:00:05:1e:d7:2b:73 \
10:00:00:05:1e:d7:3d:dc/16 ---:--:--:--:--:--:--:-- \
-----------------------------------------------------------Virtual Port WWN
PID
Enable MapType
-----------------------------------------------------------52:00:10:00:00:0f:50:30
-Yes
AG/Auto
Fabric OS Command Reference
53-1003108-01
295
2
faPwwn
11:22:33:44:55:66:77:88
52:00:10:00:00:0f:50:32
2:00:10:00:00:0f:50:33
52:00:10:00:00:0f:50:38
(output split)
11403
Yes
AG/User
11404
--
Yes
Yes
AG/Auto
AG/Auto
To display the active FA-PWWNs of all ports associated with a single AG (in the following example, one
VPWWN is not unassigned):
fapwwn --show -ag 10:00:00:05:1e:d7:3d:dc
----------------------------------------------------------AG Port
Port
Device Port WWN
\
----------------------------------------------------------10:00:00:05:1e:d7:3d:dc/16 ---:--:--:--:--:--:--:-- \
10:00:00:05:1e:d7:3d:dc/9
20
20:09:00:05:1e:d7:2b:73 \
10:00:00:05:1e:d7:3d:dc/8
20
20:08:00:05:1e:d7:2b:74 \
\
10:00:00:05:1e:d7:3d:dc/16 ---:--:--:--:--:--:--:-- \
-----------------------------------------------------------Virtual Port WWN
PID
Enable MapType
-----------------------------------------------------------52:00:10:00:00:0f:50:38
-Yes
AG/Auto
20:00:10:00:00:0f:50:33
11404
Yes
AG/Auto
11:22:33:44:55:66:77:88
11403
Yes
AG/User
52:00:10:00:00:0f:50:32
(output split)
SEE ALSO
296
None
Fabric OS Command Reference
53-1003108-01
fastBoot
2
fastBoot
Reboots the Control Processor (CP), bypassing the Power-On Self-Test (POST).
SYNOPSIS
DESCRIPTION
fastboot
Use this command to perform a "cold reboot" (power off/restart) of the CP bypassing POST when the
system comes back up. Bypassing POST can reduce boot time significantly. If POST was previously
disabled using the diagDisablePost command, then fastBoot is the same as reBoot.
The fastBoot operation is disruptive, and the command prompts for confirmation before executing.
When you reboot a switch connected to a fabric, all traffic to and from that switch stops. All Fibre Channel
ports on that switch including E_Ports become inactive until the switch comes back online.
The behavior of this command varies according to platform type:
NOTES
•
When issued on a standalone (single-processor) switch, this command performs a cold reboot of the
switch.
•
When issued on an enterprise-class platform (Brocade DCX, DCX-4S, or 48000) with two CPs
(active and standby), the following rules apply:
-
When the Standby CP reboots, it goes down and there is no failover because there is no traffic
on that switch. When the Standby CP comes up again, it is temporarily no longer in sync with
the Active CP.
-
When the Active CP reboots, it fails over to the Standby CP. The Standby CP becomes the new
Active CP and traffic is disrupted.
-
When HA is disabled and fastBoot is issued on the Active CP, both the Active and Standby CPs
reboot with the original mastership retained. The original Active CP remains the Active CP after
the reboot, and the original Standby CP remains the Standby CP. After the reboot, HA is
enabled.
-
When HA is disabled and fastBoot is issued on the Standby CP, the Standby CP reboots
without prompting. It boots up with the default switch only, even if the Active CP has multiple
logical switches configured. After the Standby CP boots up, HA is still disabled.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To reboot a standalone (single-processor) switch without executing POST on startup:
switch:admin> fastboot
Warning: This command would cause the switch to reboot
and result in traffic disruption.
Are you sure you want to reboot the switch [y/n]? y
Broadcast message from root (pts/0) Sun Feb 28 19:49:45 2010...
The system is going down for reboot NOW !!
Fabric OS Command Reference
53-1003108-01
297
2
fastBoot
To reboot a DCX without executing POST on startup (in the example, HA is enabled):
switch:admin> fastboot
Warning: This command is being run on a control processor (CP)
based system and will cause the active CP to reboot.
Are you sure you want to reboot the active CP [y/n]? y
Broadcast message from root (pts/0) Sun Feb 28 19:49:45 2010...
The system is going down for reboot NOW !!
To reboot a DCX without executing POST on startup (in the example, HA is disabled):
switch:admin> fastboot
This command is being run on a control processor (CP)
based system. Because HA is disabled, it will cause both
active CP and the standby CP to reboot. After reboot, the
HA will be enabled.
Do you want to continue [y/n] y
Broadcast message from root (pts/0) Sun Feb 28 19:49:45 2010...
The system is going down for reboot NOW !!
SEE ALSO
298
diagDisablePost, diagEnablePost, reboot, haDisable, haEnable, haFailover
Fabric OS Command Reference
53-1003108-01
fcipHelp
2
fcipHelp
Displays FCIP command information.
SYNOPSIS
DESCRIPTION
NOTES
fciphelp
Use this command to display a listing of Fibre Channel over IP (FCIP) commands with short descriptions
for each command. FCIP commands require an FCIP license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display FCIP command help information:
switch:admin> fciphelp
bladecfggemode
fciphelp
licenseslotcfg
portcfg
portcfggemediatype
portcmd
portshow
SEE ALSO
Configure 1GigE/10GigE port configuration
for blade
Print FCIP help info
Configure licenses on a slot basis
Create/Delete a new ip interface/route/arp
entry on the GigE port
Configure media type for GigE port
Execute commands (ping etc) on the GigE port
Show configured ip interfaces/routes/arp
entries or fcip tunnels on the GigE Port
portCfg, portCmd, portShow
Fabric OS Command Reference
53-1003108-01
299
2
fcipLedTest
fcipLedTest
Exercises the GbE port LEDS on the Brocade 7800 and FX8-24.
SYNOPSIS
DESCRIPTION
fcipledtest [slot | all]
Use this command to exercise the GbE port LEDs on the Brocade 7800 and FX8-24. This test cycles
through the port LEDs by lighting GREEN and then flashing GREEN on all ports for 3 seconds. As the
test continues the ports turn AMBER and then flashing AMBER for 3 seconds. The LEDs turn off when
the test has finished.
You must disable the switch before running this command.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
slot
Tests all GbE ports in the specified slot. This operand is optional; if omitted, all
GbE ports are tested. This operand is valid only on chassis-based platforms.
all
Tests all ports on the switch.
EXAMPLES
To test the LEDs on slot 4 of Brocade DCX with an FX8-24 blade.
switch:admin> fcipledtest 4
PASSED.
SEE ALSO
300
ceePortLedTest, portLedTest, switchDisable, switchEnable
Fabric OS Command Reference
53-1003108-01
fcipPathTest
2
fcipPathTest
Tests the data path of the FCIP complex.
SYNOPSIS
DESCRIPTION
fcippathtest
[--slot slot]
[-lb_mode mode]
[-nframes count]
Use this command to verify the data paths in the FCIP complex. All data path modes run tests by
comparing Fibre Channel frames or data packets transmitted from and received by the network
processor due to the designated loopback.
This command is supported only on the Brocade 7800/FX8-24 platforms.
Executing this command causes the switch or blade to reboot.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--slot slot
Specifies the slot number on which the diagnostic operates. The default is 0 and
operates on fixed-port-count products.
-lb_mode mode
Specifies the loopback mode for the test. By default, this test uses the External
(SERDES) loopback (2). Valid values are as follows:
1
Port loopback (loopback plugs)
2
External (SERDES) loopback
7
Backend bypass and port loopback
-nframes count
Specifies the number of frames to send. The test progresses until the specified
number of frames is transmitted on each port. The default value is 100.
DIAGNOSTICS
When it detects failures, the test may report one or more of the following error messages:
PATH_TEST_ERR
PATH_TEST_CHIP_INIT_ERR
PATH_TEST_IMAGE_ERR
PATH_TEST_TIMEOUT_ERR
PATH_TEST_HEARTBEAT_ERR
PATH_TEST_INVALID_RESULT
PATH_TEST_GE_PORT_ENABLE_ERR
PATH_TEST_GE_PORT_DISABLE_ERR
Fabric OS Command Reference
53-1003108-01
301
2
fcipPathTest
EXAMPLES
To run the test on slot 2:
switch:admin> fcippathtest --slot 2
Running fcippathtest ..............
Test Complete: fcippathtest Pass 10 of 10
Duration 0 hr, 1 min & 50 sec (0:1:50:942).
passed.
SEE ALSO
302
None
Fabric OS Command Reference
53-1003108-01
fcoe
2
fcoe
Manages and displays FCoE configuration.
SYNOPSIS
fcoe --cfgshow [[slot/]port]
fcoe --disable [slot/]port
fcoe --enable [slot/]port
fcoe --loginshow [[slot/]port]
fcoe --fcmapset -vlan vid fcmapid
fcoe --fcmapunset -vlan vid
fcoe --fipcfg -advintvl intvl
fcoe --fipcfgshow
fcoe --resetlogin [-teport [slot/]port | -device wwn]
fcoe --help
DESCRIPTION
Use this command to configure and display the status of FCoE ports, FCoE Initialization Protocol (FIP),
and FCMAP settings.
Unlike regular FC ports, FCoE ports are embedded interfaces that are not directly associated with an
external physical port on the switch. Although show commands such as switchShow display FCoE ports
as "ports," configuration of these ports through the regular FC CLI is disabled. Only the FCoE CLI
commands can be used.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands.
slot
Specifies the slot number on bladed systems, followed by a slash (/).
port
Specifies the port number. On the Brocade FCoE 10-24 blade, there are 24
configurable FCoE ports numbered 0 to 23. Use switchShow for a list of valid
FCoE ports.
--help
Displays the command usage.
--cfgshow
Displays the configuration of a specified embedded FCoE port. If a port is not
specified, the command displays all port configurations.
--disable
Disables the specified FCoE port.
--enable
Enables the specified FCoE port.
Fabric OS Command Reference
53-1003108-01
303
2
fcoe
--loginshow
Displays information about the devices logged in to the specified FCoE port.
--fcmapset
Configures the FCMAP values for Fabric Provided MAC Addresses (FPMA) for
the specified VLANs.
-vlan vid
Specifies the VLAN for which to set the FCMAP.
fcmapid
Specifies the FCMAP to be set.
--fcmapunset
Unsets the FCMAP for a specified VLAN. Devices previously logged in are
disconnected.
-vlan vid
Specifies the VLAN ID for which the FCMAP is unset.
--fipcfg
Configures FIP multicast advertisement intervals.
-advintvl intvl
Specifies the interval in seconds. The minimum interval value is 0 and the
maximum value is 90. A value of 0 cancels the previous advertisement interval
value. A value of 1 to 90 is valid for changing the interval.
--fipcfgshow
Displays FIP configurations.
--resetlogin
Clears the logins that occurred through a front end port or from a device specified
by the Enode's VN_Port WWN.
-teport [slot/]port
Specifies the slot or port number.
-device wwn
Specifies the device WWN.
EXAMPLES
To display the FCoE ports on the Brocade FCoE10-24:
switch:admin> switchshow -slot 8
switchName:
sw0
switchType:
77.3
switchState:
Online
switchMode:
Native
switchRole:
Subordinate
switchDomain:
2
switchId:
fffc02
switchWwn:
10:00:00:05:1e:75:af:00
zoning:
ON (longevity_cfg)
switchBeacon:
OFF
FC Router:
OFF
Fabric Name:
f1_2010_11_16_21_29_26__
Allow XISL Use: OFF
LS Attributes: [FID: 128, Base Switch: \
No, Default Switch: Yes, Address Mode 0]
Slot
Blade Type
ID
Model Name
Status
---------------------------------------------------8
AP BLADE
74
FCOE10-24
ENABLED
304
Fabric OS Command Reference
53-1003108-01
fcoe
Index Slot Port Address Media Speed State
Proto
============================================================
192
8
0
02c000
-10G
Online FCoE VF-Port 0
193
8
1
02c100
-10G
Online FCoE VF-Port 0
194
8
2
02c200
-10G
Online FCoE VF-Port 0
195
8
3
02c300
-10G
Online FCoE VF-Port 0
196
8
4
02c400
-10G
Online FCoE VF-Port 0
197
8
5
02c500
-10G
Online FCoE VF-Port 0
198
8
6
02c600
-10G
Online FCoE VF-Port 0
199
8
7
02c700
-10G
Online FCoE VF-Port 0
200
8
8
02c800
-10G
Online FCoE VF-Port 0
201
8
9
02c900
-10G
Online FCoE VF-Port 0
202
8
10
02ca00
-10G
Online FCoE VF-Port 0
203
8
11
02cb00
-10G
Online FCoE VF-Port 0
204
8
12
02cc00
-10G
Online FCoE VF-Port 0
205
8
13
02cd00
-10G
Online FCoE VF-Port 0
206
8
14
02ce00
-10G
Online FCoE VF-Port 0
207
8
15
02cf00
-10G
Online FCoE VF-Port 0
208
8
16
02d000
-10G
Online FCoE VF-Port 0
209
8
17
02d100
-10G
Online FCoE VF-Port 0
210
8
18
02d200
-10G
Online FCoE VF-Port 0
211
8
19
02d300
-10G
Online FCoE VF-Port 0
212
8
20
02d400
-10G
Online FCoE VF-Port 0
213
8
21
02d500
-10G
Online FCoE VF-Port 0
214
8
22
02d600
-10G
Online FCoE VF-Port 0
215
8
23
02d700
-10G
Online FCoE VF-Port 0
2
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
VN-Port(s)
To display devices logged in to FCoE port 2/0 on the Brocade FCoE10-24:
switch:admin> fcoe --loginshow 2/0
Number of connected devices: 1
============================================================
Peer Type Connect Info
Device WWN
Device MAC
=============================================================
FCOE_DEVICE Direct 10:00:00:05:1e:8f:fb:12 00:05:1e:8f:fb:12
==========================================================
Session MAC
FCoE Port MAC
Te port
==========================================================
0e:fc:00:91:40:01 00:05:1e:7b:34:e0
Te 2/0
To display the configuration for FCoE port 2/0 on the Brocade FCoE10-24:
switch:admin> fcoe --cfgshow 2/0
Slot: 2, Port: 0, Status: Enabled, \
Port WWN: 20:40:00:05:1e:92:de:00,
DeviceCount: 1, Type: VF-Port, MAC: 00:05:1e:7b:34:e0
VF_ID: 128, Fabric Name: 10:00:00:05:1e:35:bb:32
Fabric OS Command Reference
53-1003108-01
305
2
fcoe
To display FIP and FCMAP configuration on the Brocade FCoE10-24:
switch:admin> fcoe --fipcfgshow
FIP Unsolicited Advertisement Interval = 8
FIP Keep Alive Timeout Disabled.
========================================
VLAN fcmap
========================================
1002 0x0efc00 [Default fcmap]
========================================
SEE ALSO
306
fcoeLoginGroup, fcoeLoginCfg
Fabric OS Command Reference
53-1003108-01
fcoeLoginCfg
2
fcoeLoginCfg
Manages or displays the FCoE login configuration.
SYNOPSIS
fcoelogincfg --show
[-switch swwn | -logingroup lgname]
[-saved] | [-mergestatus]
fcoelogincfg --save
fcoelogincfg --transshow
fcoelogincfg --transabort
fcoelogincfg --purge -conflicting [-nonexisting]
fcoelogincfg --purge -nonexisting [-conflicting]
fcoelogincfg --enable
fcoelogincfg --disable
fcoelogincfg --help
DESCRIPTION
NOTES
Use this command to save, abort, or display the current FCoE login configuration, including ongoing
transactions and the effective (saved) configuration.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The FCoE Login management feature is not supported in Access Gateway mode.
OPERANDS
This command has the following operands.
--help
Displays the command usage.
--show
Displays the state of the FCoE login configuration including current transactions
and effective (saved) configuration.
-switch swwn
Displays the login groups for the specified switch.
-logingroup lgname
Displays the login group configuration for the specified login group.
-saved
Displays only the effective configuration.
-mergestatus
Displays the status of the last configuration merge during the last fabric merge.
This operand also displays conflicting login groups and login groups for
nonexisting switches.
--save
Saves and applies FCoE login configuration changes as the effective
configuration fabric-wide.
Fabric OS Command Reference
53-1003108-01
307
2
fcoeLoginCfg
--transshow
Displays the current configuration transaction in progress fabric-wide.
--transabort
Aborts the FCoE login configuration transaction currently in progress.
--purge
Purges the specified entries from the effective configuration. Specify one or both
of the following operands:
-conflicting
Purges all conflicting login groups and conflicting VN_Port mappings from the
effective configuration.
-nonexisting
Purges all login groups for nonexisting switches from the effective configuration.
--enable
Enables the FCoE login configuration management on the switch. This allows only
configured Enode VN_Ports to log in. Use the fcoeLoginGroup command to
configure allowed Enode VN_Ports.
--disable
Disables the FCoE login configuration management on the switch. This allows
unrestricted login on Enode V_Ports.
EXAMPLES
To configure a login group and save the configuration:
switch:admin> fcoelogingroup --create login_def_allowall
-self -allowall
switch:admin> fcoelogincfg --save
To display the saved configuration:
switch:admin>
fcoelogincfg --show
No ongoing transaction
Effective Configuration
***********************
Login Configuration
Switch WWN
Login group
10:00:00:05:1e:76:5c:80 login_def_allowall(active)
To display the current FCoE login configuration for the switch only:
switch:admin> fcoelogincfg --show -switch
10:00:00:05:1e:76:5c:80
\
No ongoing transaction
Effective Configuration
***********************
Logingroup name : login_def_allowall(active)
Switch wwn : 10:00:00:05:1e:76:5c:80
All devices are allowed
308
Fabric OS Command Reference
53-1003108-01
fcoeLoginCfg
2
To perform a clean-up of the effective configuration:
switch:admin> fcoelogincfg --purge -conflicting
-nonexisting
switch:admin>
\
To disable the FCoE login configuration management on the switch:
switch:admin> fcoelogincfg --disable
switch:admin> fcoelogincfg --show
Login management is disabled.
Effective Configuration
***********************
Login management is disabled.
SEE ALSO
fcoeLoginGroup
Fabric OS Command Reference
53-1003108-01
309
2
fcoeLoginGroup
fcoeLoginGroup
Creates and manages FCoE login group configuration.
SYNOPSIS
fcoelogingroup --create lgname
-self | -switch swwn [-allowall | member[;member] ...]
fcoelogingroup --delete lgname
fcoelogingroup --add lgname member[;member] ...
fcoelogingroup --remove lgname wwn
fcoelogingroup --rename lgname newlgname
fcoelogingroup --help
DESCRIPTION
NOTES
Use this command to create or modify the FCoE login management configuration fabric-wide. You can
create or delete a login group, add Virtual N_Port (VN_Port) WWNs to a login group, or remove VN_Port
WWNs from a login group.
The configuration changes effected by this command are kept in a transaction buffer until you save the
new configuration with the fabric-wide fcoelogincfg --save command.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands.
--help
Displays the command usage.
--create
Creates a login group with the specified name and associates it with a specified
switch.
lgname
Specifies the name of the login group for this switch. The maximum length is a
64-byte string.
-self
Specifies the WWN of the current switch. When this operand is specified, the login
group is associated with the current switch.
-switch swwn
Specifies the WWN of the switch for which to create the login group.
-allowall
Allows all VN_Port devices to log in to the switch.
member
Identifies the WWN of the VN_Port. The WWN must be specified in hex format as
xx.xx.xx.xx.xx.xx.xx.xx. If more than one member is specified, members must be
separated by a semicolon. Only specified members are allowed to log in to the
switch.
--delete
Deletes a login group.
310
Fabric OS Command Reference
53-1003108-01
fcoeLoginGroup
2
lgname
Specifies the name of the login group.
--add
Adds VN_Port devices to the login group.
lgname
Specifies the name of the login group to which VN_Port devices are to be added.
member
Identifies the WWN of the VN_Port. The WWN must be specified in hex as
xx.xx.xx.xx.xx.xx.xx.xx. If more than one member is specified, members must be
separated by a semicolon. Only specified members are allowed to log in to the
switch.
--remove
Removes VN_Port devices from the login group.
lgname
Specifies the name of the login group from which VN_Port devices are to be
removed.
wwn
Identifies the WWN of the VN_Port. The WWN must be specified in hex format as
xx.xx.xx.xx.xx.xx.xx.x. Only specified members are allowed to log in to the switch.
--rename
Renames the specified login group. The following operands are required:
lgname
Specifies the current name of the login group.
newlgname
Specifies the new name for the login group.
EXAMPLES
To create a login group:
switch:admin> fcoelogingroup --create mylg
-self"12:23:34:45:56:67:78:89"
\
To add a VN_Port device to the login group:
switch:admin> fcoelogingroup --add \
mylg "12:00:00:00:00:00:1e:34"
To remove a VN_Port device from the login group:
switch:admin> fcoelogingroup --remove \
mylg "12:00:00:00:00:00:1e:34"
To delete a login group:
switch:admin>fcoelogingroup --delete mylg
SEE ALSO
fcoeLoginCfg
Fabric OS Command Reference
53-1003108-01
311
2
fcPing
fcPing
Sends a Fibre Channel Extended Link Service (ELS) Echo request to a pair of ports or to a single
destination, or executes a SuperPing.
SYNOPSIS
fcping
[--number frames]
[--length size]
[--interval wait]
[--pattern pattern]
[--bypasszone]
[--quiet]
[source] destination
fcping --allpaths
[-printisl]
[-maxtries M]
[-covcount N]
[-delay D]
[-framelength len]
[-errstats]
[-vc]
destination
fcping --help
DESCRIPTION
Use this command to send a Fibre Channel ELS Echo request to a pair of ports (a source and a
destination), to a single device, or to execute a SuperPing that exercises all interswitch links (ISLs) and
internal links in different paths that route to the destination device.
•
When you use fcPing with a source and a destination, the command performs a zoning check
between the two ports. In addition, two Fibre Channel ELS requests are generated. The first ELS
request is from the domain controller to the source port identifier. The second ELS request is from
the domain controller to the destination port identifier. The ELS Echo request elicits an ELS Echo
response from a port identifier in the fabric and is useful for validating link connectivity.
The source and destination port identifiers can be specified as a 24-bit Fibre Channel port identifier
(PISD), a port World Wide Name, or a node World Wide Name. The two port identifiers are then
used to determine if the identifiers are zoned together.
•
When you use fcPing to probe a single destination, an ELS Echo is sent to the specified destination
and a response obtained. The destination can be a switch WWN, a domain ID, or a switch domain
controller ID. No zoning check is performed when a single device is probed.
•
When you use fcPing with the --allpaths option, the command exercises a "SuperPing." A
SuperPing exercises all ISLs and the internal links included in the paths that route to the destination.
It collects statistical data of all the covered paths and their port and provides optional parameters to
selectively display the data. SuperPing takes only one argument, that is, the destination port
identifier. To execute a SuperPing for two destination, you must issue the fcping --allpaths
command separately for each destination.
SuperPing facilitates troubleshooting of links that experience problems. When an echo frame is
dropped, all the ISLs and internal links potentially traversed by this frame are marked as failures. If a
fabric topology is considered fully redundant, that is, at each hop there are multiple paths to reach a
destination, a high percentage of errors are recorded on the link that experiences errors.
312
Fabric OS Command Reference
53-1003108-01
fcPing
2
Logical Fabrics: When executed in a Logical Fabric from a switch to a destination device
connected through the base fabric, SuperPing exercises all paths in the base fabric along with the
ISLs in the logical fabric. The path output indicates the LISLs and the base switch. Refer to the
Examples section for an illustration.
NOTES
The ELS Echo may not be supported on all devices. In such cases, the response could be either an ELS
reject or a request timeout.
By default, fcPing sends five ELS Echo requests to each port. When a device does not respond to the
ELS Echo request, further debugging may be needed to determine, whether the device does not support
ELS Echo, or whether the request is rejected for some other reason. Do not assume that the device is
not connected.
The execution of SuperPing requires that all switches in the fabric run Fabric OS v6.4.0 or later. For
switches running earlier versions of Fabric OS, the collected data is incomplete.
If a fabric reconfiguration occurs while SuperPing is in progress, the command reports an error message.
Exit the command and rerun the test after the fabric becomes stable again.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
destination
Specifies the destination as follows.
•
•
•
When using fcPing between a source and a destination, specify the
destination as port WWN or a node WWN.
When using fcPing to ping a single device, specify the destination as a PID,
a switch WWN, a domain ID, or a switch domain controller ID.
When using fcPing with the --allpaths option, specify the destination as a
PID, a switch WWN, or a domain ID.
source
Specifies the source port ID, port WWN, or node WWN. This operand is optional;
it is not valid with the SuperPing command (--allpaths).
The following operands are valid only when fcPing is executed without the --allpaths option (legacy
mode):
--number frames
Specifies the number of ELS Echo requests to send. The default value is 5.
--length size
Specifies the frame size of the requests in bytes. The default value is 0. Without
data, the Fibre Channel Echo request frame size is 12 bytes. The total byte count
includes four bytes from the Echo request header and eight bytes from the
timestamp. The maximum allowed value is 2,036 bytes. The length must be
word-aligned.
--interval wait
Specifies the interval, in seconds, between successive ELS Echo requests. The
default value is 0 seconds.
--pattern pattern
Specifies up to 16 "pad" bytes, which are used to fill out the request frame payload
sent. This is useful for diagnosing data-dependent problems in the fabric link. The
pattern bytes are specified as hexadecimal characters. For example, --pattern ff
fills the request frame with instances of the number 1. If a non-byte-aligned
pattern is specified, the upper nibble of the last pattern byte is filled with zeros. For
example, --pattern 123 fills the payload with a pattern of 0x1203.
Fabric OS Command Reference
53-1003108-01
313
2
fcPing
--bypasszone
Bypasses the zone check.
--quiet
Suppresses the diagnostic output. Only zoning information, if applicable, and the
summary line are displayed.
The following operands are valid only when fcPing is executed to perform a SuperPing:
--allpaths [args] destination
Executes a SuperPing that covers all available paths to the specified destination.
The number of actual paths covered depends on two other parameters that you
can optionally specify. When you issue fcping --allpaths for a destination without
any other options, SuperPing covers all ISLs in the routes between source to
destination but does exercise all possible combinations of end-to-end paths. This
operand is required when executing fcPing as SuperPing.
The following operands are optional and valid only with the --allpaths option:
-printisl
Displays statistical data for each ISL and internal port along the paths traversed
by SuperPing. This information displays in addition to the path display.
-covcount N
Specifies the minimum number of times each ISL is exercised by the SuperPing
command. The command sends N frames and checks if each ISL is exercised at
least N times. When the condition is met, superPing exits and prints the statistics.
The default value is 5.
-maxtries M
Specifies the maximum number of frames to be sent before SuperPing exits. If
both -maxtries and -covcount are specified, SuperPing checks the ISL coverage
and keeps resending frames until the minimum coverage condition to is met or
until the maximum number of echo frames specified in maxtries has been sent.
For example, assuming a coverage count of 100 and a Maxtries value of 300,
SuperPing will send 100 frames at a time and checks if each ISL is covered at
least 100 times. If not, SuperPing will keep sending 100 frames at a time to check
for coverage up to 3 times for a maximum of 300 frames (3*100 = 300) on each
egress port. If this value is set too low in relation to the specified coverage count,
not all ISLs may be covered. The default value is 100.
-delay D
Includes a delay of D milliseconds between each echo frame sent.
-framelength len
Specifies the size of the data to send.
-errstats
Collects error statistics of each user port that is part of ISLs covered through
SuperPing to reach destination domain.
-vc
Displays the ISL and internal port statistics per VC.
--help
Displays the command usage.
314
Fabric OS Command Reference
53-1003108-01
fcPing
EXAMPLES
2
To display one device that accepts the request and another device that rejects the request:
switch:admin> fcping 10:00:00:00:c9:29:0e:c4 21:00:00:20:37:25:ad:05
Source:
10:00:00:00:c9:29:0e:c4
Destination:
21:00:00:20:37:25:ad:05
Zone Check:
Not Zoned
Pinging 10:00:00:00:c9:29:0e:c4 [0x20800] with 12 bytes of data:
received reply from 10:00:00:00:c9:29:0e:c4: 12 bytes time:1162 usec
received reply from 10:00:00:00:c9:29:0e:c4: 12 bytes time:1013 usec
received reply from 10:00:00:00:c9:29:0e:c4: 12 bytes time:1442 usec
received reply from 10:00:00:00:c9:29:0e:c4: 12 bytes time:1052 usec
received reply from 10:00:00:00:c9:29:0e:c4: 12 bytes time:1012 usec
5 frames sent, 5 frames received, 0 frames rejected, 0 frames timeout
Round-trip min/avg/max = 1012/1136/1442 usec
Pinging 21:00:00:20:37:25:ad:05 [0x211e8] with 12 bytes of data:
Request rejected
Request rejected
Request rejected
Request rejected
Request rejected
5 frames sent, 0 frames received, 5 frames rejected, 0 frames timeout
Round-trip min/avg/max = 0/0/0 usec
To display one device that accepts the request and another device that does not respond to the request:
switch:admin> fcping 0x020800 22:00:00:04:cf:75:63:85
Source:
0x020800
Destination:
22:00:00:04:cf:75:63:85
Zone Check:
Zoned
Pinging 0x020800 with 12 bytes of data:
received reply from 0x020800: 12 bytes time:1159 usec
received reply from 0x020800: 12 bytes time:1006 usec
received reply from 0x020800: 12 bytes time:1008 usec
received reply from 0x020800: 12 bytes time:1038 usec
received reply from 0x020800: 12 bytes time:1010 usec
5 frames sent, 5 frames received, 0 frames rejected,0 frames timeout
Round-trip min/avg/max = 1006/1044/1159 usec
Pinging 22:00:00:04:cf:75:63:85 [0x0217d9] with 12 bytes of data:
Request timed out
Request timed out
Request timed out
Request timed out
Request timed out
5 frames sent, 0 frames received, 0 frames rejected,5 frames timeout
Round-trip min/avg/max = 0/0/0 usec
To use fcping with a single destination:
switch:admin> fcping 20:03:00:05:33:7e:97:e9
Pinging 20:03:00:05:33:7e:97:e9 [0x022300] with 12 bytes of
Request rejected
Request rejected by 0x022300: Command not supported: time:
Request rejected by 0x022300: Command not supported: time:
Request rejected by 0x022300: Command not supported: time:
Fabric OS Command Reference
53-1003108-01
data:
1159 usec
1006 usec
1008 usec
315
2
fcPing
Request rejected by 0x022300: Command not supported: time: 1038 usec
Request rejected by 0x022300: Command not supported: time: 1010 usec
5 frames sent, 0 frames received, 5 frames rejected, 0 frames timeout
Round-trip min/avg/max = 1006/1044/1159 usec
To use fcPing with a single destination (in the example, the destination is a switch WWN):
switch:admin> fabricshow
Switch ID
Worldwide Name
Enet IP Addr
FC IP Addr Name
----------------------------------------------------------------6: fffc06 10:00:00:05:1e:34:2b:66 10.202.90.201 0.0.0.0 "mps_daz_1"
55:fffc37 10:00:00:05:1e:34:01:f5 10.202.90.226 0.0.0.0 pulsar055"
switch:admin> fcping 10:00:00:05:1e:34:2b:66
Destination:
10:00:00:05:1e:34:2b:66
Pinging 20:00:00:05:1e:34:2b:66 [fffc06] with 12 bytes
received reply from 10:00:00:05:1e:34:2b:66 : 12 bytes
received reply from 10:00:00:05:1e:34:2b:66 : 12 bytes
received reply from 10:00:00:05:1e:34:2b:66 : 12 bytes
received reply from 10:00:00:05:1e:34:2b:66 : 12 bytes
received reply from 10:00:00:05:1e:34:2b:66 : 12 bytes
5 frames sent, 5 frames received, 0 frames rejected, 0
Round-trip min/avg/max = 1012/1136/1442 usec
of data:
time:1162 usec
time:1013 usec
time:1442 usec
time:1052 usec
time:1012 usec
frames timeout
To use fcPing with a single destination (in the example, the destination is a device node WWN):
switch:admin> nsshow
{
Type Pid
COS
PortName
NodeName
TTL(sec)
N 370500;3;20:07:00:05:1e:35:10:7f;10:00:00:05:1e:35:10:7f; na
Fabric Port Name: 20:05:00:05:1e:34:01:f5
Permanent Port Name: 20:07:00:05:1e:35:10:7f
Port Index: 5
Share Area: No
Device Shared in Other AD: No
Redirect: No
Partial: NO
N 370501; 3;10:00:00:00:c9:3f:7c:b8;20:00:00:00:c9:3f:7c:b8; na
FC4s: FCP
NodeSymb: [44] "Emulex LP1050 FV1.81A1 DV5-5.20A9 DELL1750-3"
Fabric Port Name: 20:05:00:05:1e:34:01:f5
Permanent Port Name: 20:07:00:05:1e:35:10:7f
Port Index: 5
Share Area: No
Device Shared in Other AD: No
Redirect: No
Partial: NO
The Local Name Server has 2 entries }
switch:admin> fcping 20:00:00:00:c9:3f:7c:b8
Destination:
20:00:00:00:c9:3f:7c:b8
Pinging 20:00:00:00:c9:3f:7c:b8 [0x370501] with 12 bytes of data:
received reply from 20:00:00:00:c9:3f:7c:b8:12 bytes time:825 usec
received reply from 20:00:00:00:c9:3f:7c:b8:12 bytes time:713 usec
316
Fabric OS Command Reference
53-1003108-01
fcPing
2
received reply from 20:00:00:00:c9:3f:7c:b8:12 bytes time:714 usec
received reply from 20:00:00:00:c9:3f:7c:b8:12 bytes time:741 usec
received reply from 20:00:00:00:c9:3f:7c:b8:12 bytes time:880 usec
5 frames sent,5 frames received,0 frames rejected,0 frames timeout
Round-trip min/avg/max = 713/774/880 usec
To execute a SuperPing testing all ISLs to a specified destination (in the example, two paths are tested,
and each hop is displayed in Domain/Index format):
switch:admin> fcping --allpaths 165
Pinging(size:12 bytes) destination domain 165 through all paths
PATH SWITCH1-->
SWITCH2-->
SWITCH3-->
\
------------------------------------------------------------1.(3/EMB,3/205)[128] (207/25,207/42)[128] (101/3,101/16)[128]\
2.(3/EMB,3/204)[128] (207/27,207/42)[128] (101/3,101/16)[128]\
SWITCH4
STATUS
---------------------------(165/99,165/0)[128] SUCCESS
2(165/99,165/0)[128] SUCCESS
To execute a SuperPing in a logical fabric (in the example, domains 10 and 40 in FID 1 are connected
through the base fabric (FID 2)):
switch:admin: fcping --allpaths 40
Pinging(size:12 bytes) destination domain 30 through all paths
PATH SWITCH1--> SWITCH2-->
-------------------------------------------------------1.(10/EMB,10/4)[128] (20/5,20/EMB )[128] (1/EMB, 1/6)[2] \
Successfully completed superping for all paths
SWITCH3-->
SWITCH4
STATUS
--------------------------------------------------------(2/7,2/EMB)[2] (30/EMB,30/8)[128] (40/9, 40/EMB)[128] SUCCESS
Successfully completed superping for all paths
To execute a SuperPing and print statistical coverage of each ISL and internal port along the potential
paths (in the example, a few errors are recorded on the ISLs 3/205->2/25, 3/204->2/27, 2/42->101/3, and
2/1->101/8, but the internal port analysis shows that errors are recorded on the internal port 0/284 in
domain 2, which is the potential faulty link):
switch:admin> fcping --allpaths -printisl 101
Pinging(size:12 bytes) destination domain 101 through all paths
PATH
SWITCH1-->
SWITCH2-->
-----------------------------------------------1.
( 3/EMB, 3/123)[128] (165/96 ,165/99 )[128]
2.
( 3/EMB, 3/205)[128] ( 2/25 , 2/1 )[128]
3.
( 3/EMB, 3/205)[128] ( 2/25 , 2/42 )[128]
4.
( 3/EMB, 3/204)[128] ( 2/27 , 2/42 )[128]
5.
( 3/EMB, 3/204)[128] ( 2/27 , 2/1 )[128]
\
\
\
\
\
\
SWITCH3
STATUS
--------------------------------(101/16 ,101/EMB)[128]
SUCCESS
Fabric OS Command Reference
53-1003108-01
317
2
fcPing
(101/8 ,101/EMB)[128]
(101/3 ,101/EMB)[128]
4(101/3 ,101/EMB)[128]
101/8 ,101/EMB)[128]
FAILED
FAILED
FAILED
FAILED
Completed superping for all paths. Error found in few paths
ISL COVERAGE
------------SNO
ISL
STATUS
--------------------------------------------------1
( 3/123[128]-->165/96[128] )
SUCCESS(5/5)
2
( 3/205[128]--> 2/25[128] )
FAILURE(7/50)
3
( 3/204[128]--> 2/27[128] )
FAILURE(11/50)
4
(165/99[128] -->101/16[128] )
SUCCESS(5/5)
6
( 2/42[128] -->101/3[128] )
FAILURE(10/67)
7
( 2/1[128] -->101/8[128] )
FAILURE(8/33)
INTERNAL PORT COVERAGE
----------------------SNO
DOMAIN INTRNL_PORT
STATUS
------------------------------------------1
2
0/272
SUCCESS(40/40)
2
2
0/276
SUCCESS(44/44)
3
2
0/280
SUCCESS(30/30)
4
2
0/284
FAILURE(20/20)
To execute a superPing with a coverage count of 1000 and a maxtries value of 5000 (in the example, the
ISL (3/204->204/27), could not be covered 1000 times):
switch:admin> fcping --allpaths -covcount 1000
-maxtries 5000 -printisl 165
\
Pinging(size:12 bytes) destination domain 165 through all paths
|
PATH SWITCH1--> SWITCH2-->
SWITCH3-->
\
------------------------------------------------------------1.(3/EMB,3/205)[128] (207/25,207/42)[128] (101/3,101/16)[128]\
2.(3/EMB,3/204)[128] (207/27,207/42)[128] (101/3,101/16)[128]\
SWITCH4
STATUS
--------------------------(165/99,165/0)[128] SUCCESS
(165/99,165/0)[128] SUCCESS
Successfully completed superping for all paths
ISL COVERAGE
------------SNO
ISL
STATUS
---------------------------------------------------1
( 3/205-->207/25 )
SUCCESS(4025/4025)
2
( 3/204-->207/27 )
SUCCESS(5/5)
3
(207/42 -->101/3 )
SUCCESS(4030/4030)
4
(101/16 -->165/99 )
SUCCESS(4030/4030)
318
Fabric OS Command Reference
53-1003108-01
fcPing
2
INTERNAL PORT COVERAGE
----------------------SNO
DOMAIN INTRNL_PORT
STATUS
-----------------------------------------
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
319
2
fcpLogClear
fcpLogClear
Clears the FCPD debug information log.
SYNOPSIS
DESCRIPTION
NOTES
fcplogclear
Use this command to clear the debug information logged by the Fibre Channel Protocol daemon (FCPD).
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To clear the FCPD debug information log:
switch:admin> fcplogclear
SEE ALSO
320
fcpLogDisable, fcpLogEnable, fcpLogShow
Fabric OS Command Reference
53-1003108-01
fcpLogDisable
2
fcpLogDisable
Disables the FCPD debug information log.
SYNOPSIS
DESCRIPTION
NOTES
fcplogdisable
Use this command to disable the logging of debug information by the Fibre Channel Protocol daemon
(FCPD).
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable the FCPD debug information log:
switch:admin> fcplogdisable
SEE ALSO
fcpLogClear, fcpLogEnable, fcpLogShow
Fabric OS Command Reference
53-1003108-01
321
2
fcpLogEnable
fcpLogEnable
Enables the FCPD debug information log.
SYNOPSIS
DESCRIPTION
NOTES
fcplogenable
Use this command to enable Fibre Channel Protocol daemon (FCPD) logging. Debug information
logging is enabled by default.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable the FCPD debug information log:
switch:admin> fcplogenable
SEE ALSO
322
fcpLogClear, fcpLogDisable, fcpLogShow
Fabric OS Command Reference
53-1003108-01
fcpLogShow
2
fcpLogShow
Displays the FCPD debug information log.
SYNOPSIS
fcplogshow
DESCRIPTION
Use this command to display the debug information logged at various stages during the Fibre Channel
Protocol daemon (FCPD) device probing.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the FCPD debug information log:
switch:admin> fcplogshow
Switch 0; Sat Dec 18 14:22:05 2010
14:22:05.799269 Flush or Probe rcvd, port 15, \
Line: 16777862, scn_type: 2
14:22:05.799279 Probe flush, port:15, \
Line:16780554, flag:0
14:22:17.469561 Flush or Probe rcvd, port 15, \
Line: 16777862, scn_type: 1
14:22:17.469567 Probe Msg Rcvd, port: 15, Line: 16777899, \
prev_state: 0, msg_scn_arg1: 0
14:22:17.470618 fcpStartProbe, port: 15, line: 16778347, \
async_state: 1, origin: 0,probe_state: 0, opt_code: 0
14:22:17.471052 fcpStartProbe, port: 15, line: 16778413, \
async_state: 1073741824, origin: 0,probe_state: 0, opt_code: 0
14:22:17.471057 Probe flush, port:15, Line:16780554, flag:1
(output truncated)
SEE ALSO
fcpLogClear, fcpLogDisable, fcpLogEnable
Fabric OS Command Reference
53-1003108-01
323
2
fcpProbeShow
fcpProbeShow
Displays the Fibre Channel Protocol (FCP) probe information.
SYNOPSIS
DESCRIPTION
fcpprobeshow [slot/]port
Use this command to display the Fibre Channel Protocol daemon (FCPD) device probing information for
the devices attached to the specified F_Port or FL_Port. This information includes the number of
successful logins and SCSI INQUIRY commands sent over this port and a list of the attached devices.
For switches running Fabric OS v7.0.0 or later, this command includes probing information for NPIV
devices. In addition, this command displays the list of devices connected to a port and the number of
successful PLOGI, PRLI, INQUIRies, and current probe state.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
slot
For bladed systems only, specify the slot number of the port to display, followed by
a slash (/).
port
Specify the port number to display, relative to its slot for bladed systems. Use
switchShow to list valid ports. This operand is required.
EXAMPLES
To display the FCP probe information:
switch:admin> fcpprobeshow 31
port 0 is FV-Port and it is online.
nodes probed:
3
successful PLOGIs:
3
successful PRLIs:
3
successful INQUIRies:3
successful LOGOs:
3
outstanding IUs:
0
probing state:
3
probing TOV:
0
probing count:
0
probing next:
0
pmap:
0x00000000, 0x00000000, 0x00000000, 0x00000000
update map: 0x40000000, 0x00000000, 0x00000000, 0x00000000
npiv pmap:
0x00000000 0x00000000 0x00000000 0x00000000 \
0x00000000 0x00000000 0x00000000 0x00000000
npiv update map:
0x00000006 0x00000000 0x00000000 0x00000000 \
0x00000000 0x00000000 0x00000000 0x00000000
list of devices(may include old NPIV devices):
0x500e8: SEAGATE ST318452FC
0005
0x500e4: SEAGATE ST318452FC
0001
0x500e2: SEAGATE ST318452FC
0005
SEE ALSO
324
portLoginShow, portLogShow
Fabric OS Command Reference
53-1003108-01
fcpRlsProbe
2
fcpRlsProbe
Initiates the Fibre Channel Protocol (FCP) Read Link Status (RLS) probing for F_Port and displays the
RLS information.
SYNOPSIS
fcpRlsProbe --start [slot/]port_list
fcpRlsProbe --show [slot/]port
fcpRlsProbe --help
DESCRIPTION
Use this command to initiate the FCP RLS probing or to display the RLS information. This information
describes the number of link failures, loss-of-signal, loss-of-sync, CRC errors, and other failure events
detected on the specified port.
Use the fcprlsprobe --start command to read the error status block for F/FL-Ports. This command will
send a RLS ELS probe to the device on the specified port and caches the RLS information. Use the
fcprlsprobe --show command to display the cached RLS information. For the command to send RLS
probe to the device you must enable the following parameter: Disable Device Probing = 0 (Enables
device probing. By default Device probing is enabled).
For this command to gather and display F_Port error statistics, apart from enabling the device probing,
you must enable RLS Probing using the fcprlsprobe --start command or use the configure command,
"Disable RLS Probing". By default, RLS probing is disabled.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
slot
Specifies the slot number, if applicable, followed by a slash (/).
port_list
Specifies a port number. You can specify a port or range of ports.
--start
Sends the ELS RLS to the device and gets the RLS information.
--show
Displays the RLS information.
--help
Displays the command usage.
EXAMPLES
To start the RLS probing:
switch:admin> fcprlsprobe --start 1
RLS probing initiated...
Please use the fcprlsprobe --show port command to view the RLS info.
To view the RLS information:
switch:admin> fcprlsprobe --show 1
Rls Probing Statistics for port 1
====================================
AL_PA 0x0
--------RLS Probe Status
: SUCCESS
Fabric OS Command Reference
53-1003108-01
325
2
fcpRlsProbe
Last Updated
: Fri May 18 08:44:11 2012
--------------------------------------------------------link fail loss sync loss sig prtc err bad word crc err
--------------------------------------------------------0
6
6
0
65555
0
SEE ALSO
326
fcpRlsShow
Fabric OS Command Reference
53-1003108-01
fcpRlsShow
2
fcpRlsShow
Displays the Fibre Channel Protocol (FCP) Read Link Status (RLS) information.
SYNOPSIS
DESCRIPTION
fcprlsshow [slot/]port
Use this command to display the FCP RLS information for an F_Port or FL_Port. This information
describes the number of loss-of-signal, loss-of-sync, CRC errors, and other failure events detected on
the specified port.
For this command to gather and display F_Port error statistics,
•
you must enable the configuration parameter: Disable Device Probing = 0 (Enables device probing.
By default Device probing is enabled).
•
you must enable RLS Probing in the following ways: Use the fcprlsprobe --startcommand which
enables RLS Probing or use the configure command "Disable RLS Probing" to enable RLS
probing. Disable RLS Probing = Off (Enables RLS Probing) by default RLS probing is disabled.
Use the fcprlsprobe --show command to view the RLS information.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
slot
For bladed systems only, specifies the slot number of the port to display, followed
by a slash (/).
port
Specifies the port number to display, relative to its slot for bladed systems. Use
switchShow for a listing of valid ports. This operand is required.
EXAMPLES
To display the FCP RLS information:
switch:admin> fcprlsshow 9
RLS Probing Statistics for port 9
=================================
AL_PA 0x1
==========
RLS Probe Status
: SUCCESS
Last Updated
: Mar 4 03:17:50 2012
----------------------------------------------------------link fail loss sync loss sig prtc err bad word crc err
----------------------------------------------------------1138
65047
1138
0
4996278
71
AL_PA 0x2
==========
RLS Probe Status
Last Updated
: FAIL (RLS Send timed out)
: Mar 4 03:17:50 2012
AL_PA 0x3
==========
RLS Probe Status
: SUCCESS
Fabric OS Command Reference
53-1003108-01
327
2
fcpRlsShow
Last Updated
: Mar 4 03:17:52 2012
-----------------------------------------------------------link fail loss sync loss sig prtc err bad word crc err
-----------------------------------------------------------147
1035
118
0
306278
72
SEE ALSO
328
portLoginShow, portShow
Fabric OS Command Reference
53-1003108-01
fcrBcastConfig
2
fcrBcastConfig
Displays or sets the broadcast frame forwarding option.
SYNOPSIS
fcrbcastconfig --show
fcrbcastconfig --enable -f fabric_id
fcrbcastconfig --disable -f fabric_id
fcrbcastconfig --help
DESCRIPTION
NOTES
OPERANDS
Use this command to enable or disable the broadcast frame option or to display the current configuration.
If no operands are specified, this command displays the usage. By default, frame forward option is
disabled. Use the --show option to display the current settings on the switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--show
Shows the current broadcast configuration as enabled or disabled. If broadcast
frame forwarding is disabled for selected FIDs, only the enabled FIDs in the
current configuration are displayed.
--enable
Enables the frame forwarding option for a specified fabric ID.
--disable
Disables the frame forwarding option for a specified fabric ID
-f fabric_id
Specifies the fabric ID to be disabled or enabled. Valid values are 1 to 128. This
operand is required with the --enable and --disable options.
--help
Displays the command usage.
EXAMPLES
To display the current configuration:
fcr:admin> fcrbcastconfig --show
Broadcast configuration is disabled for all FID
To enable broadcast frame forwarding for FID 33, 28, and 2:
fcr:admin> fcrbcastconfig --enable -f 33
fcr:admin> fcrbcastconfig --enable -f 28
fcr:admin> fcrbcastconfig --enable -f 2
To display the new configuration:
fcr:admin> fcrbcastconfig --show
Broadcast configuration is enabled for FID:
2 33 128
To disable broadcast frame forwarding for FID 33:
fcr:admin> fcrbcastconfig --disable -f 33
Fabric OS Command Reference
53-1003108-01
329
2
fcrBcastConfig
To display the new configuration:
switch:admin> fcrbcastconfig --show
Broadcast configuration is enabled for FID:
2 128
SEE ALSO
330
bcastShow, portRouteShow
Fabric OS Command Reference
53-1003108-01
fcrConfigure
2
fcrConfigure
Displays or sets FC Router configuration parameters.
SYNOPSIS
fcrconfigure --bbfid
fcrconfigure --enable -shortestifl
fcrconfigure --disable -shortestifl
fcrconfigure --show
fcrconfigure --help
DESCRIPTION
Use this command to change the backbone fabric ID, or to enable or disable the shortest inter-fabric link
(IFL) mode. If no operands are specified, this command displays the usage. Use the --show option to
display the current settings on the switch.
Before you configure the backbone fabric ID using the --bbfid option, you must disable FC routing by
using the fosConfig command and disable the switch using the switchDisable command.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--bbfid
Specifies the Backbone Fabric ID. This is an interactive option. A fabric ID
uniquely identifies a fabric in FC Router configurations. The backbone fabric is the
fabric attached to the U_Ports of the switch, for example, E_Ports or F_Ports. The
backbone fabric ID must be unique across all fabrics connected to the FC Router.
Use the switchShow command to display the current Backbone Fabric ID.
--enable -shortestifl
Enables the shortest IFL mode in FC Router.
When the shortest IFL mode is enabled, FC Router can choose a lowest-cost IFL
path in the backbone fabric. This feature is useful when an FC Router has multiple
connections to the source edge fabric and the backbone fabric has multiple FC
Routers connected through FCIP links (VE_Ports) and FC links (E_Ports).
Because a domain in an edge fabric can choose any equal cost path to reach the
translate domain, frames can be transmitted through FCIP links even though FC
links are present in the backbone fabric. When the shortest IFL mode is enabled,
the FCIP path in the backbone fabric is avoided while reaching the destination
edge fabric.
You should identify the FCIP links in the backbone fabric and then the direction of
the FCIP path (across the backbone fabric) from the source to the destination
edge fabric. Once the direction of the FCIP path is identified, set the cost of the
FCIP link greater than or equal to 10000 by using the linkCost command. The link
cost must be set for all FC Routers in the identified FCIP link path. Likewise,
identify and set the cost for other FCIP paths of all destination edge fabrics.
Fabric OS Command Reference
53-1003108-01
331
2
fcrConfigure
After you identify the FCIP links between FC Routers for all fabrics and updated
the cost of all FCIP links, enable the shortest IFL mode in all the FC Routers in the
backbone fabric using this option. If the FCIP link is the only available path from
the source to the destination edge fabric, then traffic will flow through that FCIP
link only.
--disable -shortestifl
Disables the shortest IFL mode in FC Router.
--show
Shows the current Backbone Fabric ID and the status of the shortest IFL mode as
enabled or disabled.
--help
Displays the command usage.
EXAMPLES
To configure FC Router parameters:
fcr:admin> fcrconfigure --bbfid
Backbone fabric ID parameter set. <cr> to skip this parameter
Please make sure new Backbone Fabric ID does \
not conflict with any configured EX-Port's Fabric ID
Backbone fabric ID: (1-128)[128]32
To enable shortest IFL mode:
fcr:admin> fcrconfigure --enable -shortestifl
Shortest IFL path is enabled.
To disable shortest IFL mode:
fcr:admin> fcrconfigure --disable -shortestifl
Shortest IFL path is disabled
To display the current configuration:
fcr:admin> fcrconfigure --show
Backbone fabric ID: 32
Shortest IFL feature is disabled
SEE ALSO
332
fosConfig, switchDisable, switchEnable, switchShow, linkCost
Fabric OS Command Reference
53-1003108-01
fcrEdgeShow
2
fcrEdgeShow
Displays the FIDs of all configured EX_Ports.
SYNOPSIS
fcredgeshow
fcredgeshow [-fid FabricID]
fcredgeshow --help
DESCRIPTION
Use this command without operand to display information about all Fabric IDs (FIDs) that have been
created on the chassis and are assigned to EX_Ports.
When a FID is specified, fcredgeshow displays information for all EX_Ports configured with the
specified FID.
For each FID, the command output includes the following:
FID
Fabric ID of the EX_Port.
EX-port
EX_Port number of the switch.
E_Port
Port number for the remote E_Port.
PWWN
Neighbor switch port WWN.
SWWN
Neighbor switch WWN.
Flags
encryption, compression and fec features
The command output depends on the EX_Port configuration:
OPERANDS
•
If the EX_Port is online, the command displays the FID, the EX_Port to which it is assigned, the
E_Port, the port WWN, the switch WWN and Port flags. Inter Chassis Link (ICL) EX_Ports do not
support encryption and compression.
•
If the EX_Port is offline, the command displays the FID, the EX_Port to which it is assigned, and an
"OFFLINE" message.
•
•
IF no EX_Ports are configured in the switch, the command displays "No EX-port Configured".
If no EX_Ports are configured within the specified FID, the command displays the following
message: "No EX-ports with FID FabricID."
This command has the following operands:
-fid FabricID
Specifies the FID for which to display the configured EX_Ports.
--help
Displays the command usage.
Fabric OS Command Reference
53-1003108-01
333
2
fcrEdgeShow
EXAMPLES
To display the EX_Ports configured in the switch:
switch:admin> fcredgeshow
FID EX-port E-port Neighbor Switch (PWWN, SWWN ) Flags
----------------------------------------------------------------25
1/13
244 20:f4:00:05:1e:38:a4:cb 10:00:00:05:1e:38:a4:cb FEC \
ENCRYPTION COMPRESSION
35
1/12
299 2e:2b:00:05:1e:40:44:02 10:00:00:05:1e:40:44:02 ENCRYPTION \
COMPRESSION
11
5/13
273 2e:11:00:05:33:b3:39:00 10:00:00:05:33:b3:39:00 FEC
To display the EX_Ports configured with a specified FID:
switch:admin> fcredgeshow -fid 25
FID EX-port E-port Neighbor Switch (PWWN, SWWN ) Flags
----------------------------------------------------------------25 11
244 20:f4:00:05:1e:38:a4:cb 10:00:00:05:1e:38:a4:cb FEC
ENCRYPTION \
COMPRESSION
To display a FID for which no EX_Ports are configured:
switch:admin> fcredgeshow -fid 29
No EX-ports with FID 29
SEE ALSO
334
fcrPhyDevShow, fcrProxyDevShow, fcrRouteShow, lsanZoneShow, switchShow, fcrFabricShow
Fabric OS Command Reference
53-1003108-01
fcrFabricShow
2
fcrFabricShow
Displays the FC Routers on a backbone fabric.
SYNOPSIS
fcrfabricshow
fcrfabricshow --name
fcrfabricshow --help
DESCRIPTION
Use this command to display information about FC Routers that exist in an FC Router backbone fabric.
The existing syntax is maintained for IPv6 support. When IPv6 addresses are not configured, the output
of fcrFabricShow displays the IPv4 format. Use the --name option to display the fabric name along with
EX-port, FID, and switch name.
The message "No active FC Routers found" is displayed if no active FC Routers are present on the
backbone fabric.
The following information is displayed for each FC Router found on the backbone fabric:
WWN
The world wide name of the FC Router.
Domain ID
The domain ID of the FC Router. This domain ID is relevant only on the backbone
fabric.
Info
The Ethernet IP address and switch name of the FC Router. When IPv6
addresses are configured, only the static IP address displays for each FC Router
found on the backbone fabric.
EX_Ports
A listing of active EX_Ports for the FC Router and information about these
EX_Ports. This information includes:
EX_Port
The port number for the EX_Port. An asterisk (*) at the end of the line indicates
that the EX_Port is a Remote Router Port.
FID
The fabric ID of the EX_Port.
Neighbor Switch Info (WWN, enet IP, name)
The WWN, Ethernet IP address, and switch name of the switch attached to the
EX_Port.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand.
--name
Displays the FC Routers on a backbone fabric with edge fabric names.
--help
Displays the command usage.
Fabric OS Command Reference
53-1003108-01
335
2
fcrFabricShow
EXAMPLES
To display the FC Routers in the backbone fabric:
switch:admin> fcrfabricshow
FC Router WWN: 10:00:00:05:1e:41:59:81, Dom ID:
2, Info:
10.33.36.8, "swd77"
EX_Port FID Neighbor Switch Info (enet IP, WWN, name)
-----------------------------------------------------12
5 10.33.35.81 10:00:00:05:1e:34:01:d0 "B10_4"
FC Router WWN: 10:00:00:05:1e:41:1c:73, Dom ID:
4, Info:
10.33.36.12, "ttv12"
EX_Port FID Neighbor Switch Info (enet IP, WWN, name)
------------------------------------------------------9
2 10.33.35.80 10:00:00:05:1e:38:01:e7 "B10_3"
10
2 10.33.35.80 10:00:00:05:1e:38:01:e7 "B10_3"
FC Router WWN: 10:00:00:05:1e:39:51:67, Dom ID:
5, Info:
10.33.36.96, "Scimitar"
EX_Port FID Neighbor Switch Info (enet IP, WWN, name)
-------------------------------------------------------151
2 10.33.35.80 10:00:00:05:1e:38:01:e7 "B10_3"*
To display the fabric name along with EX-port, FID, and switch name:
switch:admin> fcrfabricshow --name
FC Router WWN: 10:00:00:05:33:13:70:3e, Dom ID:
1,
Info: 10.17.33.129, "U34"
EX_Port
FID
Neighbor Switch Info (swname, fabricname)
---------------------------------------------------------------16
22
"SPIRIT-2" "FOSFCR"
17
22
"SPIRIT-2" "FOSFCR"
18
22
"SPIRIT-2" "FOSFCR"
FC Router WWN: 10:00:00:05:33:13:74:3e, Dom ID:
2,
Info: 10.17.33.128, "U35"
EX_Port
FID
Neighbor Switch Info (swname, fabricname)
---------------------------------------------------------------7
33
"STINGER-U33" "BODCFCR"
4
33
"STINGER-U33" "BODCFCR"
5
33
"STINGER-U33" "BODCFCR"
6
33
"STINGER-U33" "BODCFCR"
SEE ALSO
336
fcrPhyDevShow, fcrProxyDevShow, fcrRouteShow, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrIclPathBWMonitor
2
fcrIclPathBWMonitor
Sets or displays FC Router ICL bandwidth monitor parameters for EX_Ports.
SYNOPSIS
fcriclpathbwmonitor --enable
fcriclpathbwmonitor --disable
fcriclpathbwmonitor --show
fcriclpathbwmonitor --help
DESCRIPTION
NOTES
OPERANDS
Use this command to enable or disable the Inter Chassis Link (ICL) EX_Ports bandwidth Monitor feature
on an FC Router, or to display the current status of ICL bandwidth feature and the ICL slot bandwidth
assigned to connected edge fabrics. If no operands are specified, this command displays the usage. By
default, this feature is disabled.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--enable
Enables the ICL EX_Port bandwidth Monitor feature on an FC Router. In the
enable mode, FC Router will periodically check for bandwidth imbalances from
each ICL slot of FC Router to each ICL slot of neighbor switch connected through
EX_Ports. A RASLog message will be generated when bandwidth imbalance is
detected or resolved to other fabric.
--disable
Disables the ICL EX_Port bandwidth Monitor feature on an FC Router.
--show
Displays the current ICL EX_Port bandwidth Monitor feature status and bandwidth
from each slot to connected edge fabric.
--help
Displays the command usage.
EXAMPLES
To enable ICL EX_Port bandwidth Monitor:
fcr:admin> fcriclpathbwmonitor --enable
ICL bandwidth balance Monitor functionality is enabled
To disable ICL EX_Port bandwidth Monitor:
fcr:admin> fcriclpathbwmonitor --disable
ICL bandwidth balance Monitor functionality is disabled
Fabric OS Command Reference
53-1003108-01
337
2
fcrIclPathBWMonitor
To display the current configuration:
fcr:admin> fcriclpathbwmonitor --show
ICL Path Bandwidth state :Enabled
FABRIC SLOT-3 BW SLOT-6 BW
STATE
========================================
48
128
128
BALANCED
126
64
128
UNBALANCED
SEE ALSO
338
fosConfig, switchDisable, switchEnable, switchShow
Fabric OS Command Reference
53-1003108-01
fcrLsan
2
fcrLsan
Configures and displays LSAN policies.
SYNOPSIS
fcrlsan
fcrlsan --add -enforce tag | -speed tag
fcrlsan --remove -enforce tag | -speed tag
fcrlsan --show -enforce | -speed | all
fcrlsan --help
DESCRIPTION
Use this command to add or remove LSAN tags, or to display existing tags in the configuration. LSAN
tagging optimizes an FC Router's behavior based on a specified subset of LSANS. This feature improves
scalability and performance related to LSAN zone size and the speed with which they are imported or
exported.
This command supports two types of LSAN tags: enforced tags and speed tags.
•
Enforced LSAN tags filter zones accepted by the FC Router from the edge fabric by matching the
zones to the configured tags. Only matching zones are accepted into the local database for export
and import. For example, if you configure an enforced LSAN tag "BRCD" on a router, only zones
with names starting with "lsan_BRCD" are accepted. If multiple tags are configured, any matching
zones are accepted. A maximum of eight LSAN enforce tags are configurable per FC Router switch.
•
A speed tag is a flag to indicate to the FCR that the targets in the LSANs matching the tag need to
be imported permanently when host and target are zoned together, even if the host is not present.
This mechanism facilitates a speedy discovery process by reducing instances of failure related to
timeouts. Once the devices that belong to the target edge fabric are defined as speed LSANS, the
import or export can occur with a minimum amount of delay when hosts reboot or are added to the
zone database.
The following restrictions apply when configuring LSAN tags:
•
•
The FC router must run Fabric OS v6.2.0 or later.
•
You must change the LSAN name in the edge fabric or the backbone fabric and propagate the LSAN
to the FCR. Note that enforce tags are not supported in the backbone fabric.
•
The speed tags must be set in all related FC Routers in order for import and export to proceed
correctly. However, only LSANs on the target edge fabric must append the tag.
The switch must be disabled when you configure enforce tags. Speed tags can be configured while
the switch is online.
When executed without operands, fcrlSan displays the command usage.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--add
Adds the specified tag to the LSAN tag configuration.
--remove
Removes the specified tag from the LSAN tag configuration.
Fabric OS Command Reference
53-1003108-01
339
2
fcrLsan
--show
Displays the specified tag from the LSAN tag configuration.
--help
Displays the command usage.
-enforce tag
Accepts only the LSANs from the edge fabric that matches the specified tag string
into the local FCR database. A valid tag is a string of a maximum of eight
characters. The maximum configurable enforced tags is eight.
-speed tag
Allows the FCR to always import these target devices to the hosts specified in the
LSANs that match the speed tag. Only one speed tag is allowed per FC router.
-all
When used with the --show option, this command displays all LSAN tags in the
FCR LSAN tag database.
EXAMPLES
To add an LSAN enforcement tag named "brocade":
switch:admin> switchdisable
switch:admin> fcrlsan --add -enforce brocade
LSAN tag set successfully
To add a speed tag named "mcdt":
switch:admin> fcrlsan --add -speed mcdt
LSAN tag set successfully
To remove the LSAN enforcement tag "brocade":
switch:admin> fcrlsan --remove -enforce brocade
LSAN tag removed successfully
To remove the speed tag "mcdt":
switch:admin> fcrlsan --remove -speed mcdt
LSAN tag removed successfully
To display the information from the cache:
switch:admin> fcrlsan --show -enforce
Total LSAN tags : 2
ENFORCE : brocade
ENFORCE : cisco
switch:admin> fcrlsan --show -speed
Total LSAN tags : 1
SPEED: mcdt
switch:admin> fcrlsan --show -all
Total LSAN tags : 3
ENFORCE : brocade
ENFORCE : cisco
SPEED: mcdt
SEE ALSO
340
fcrFabricShow, lsanZoneShow, fcrPhyDevShow, fcrProxyDevShow, fcrRouteShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrLsanCount
2
fcrLsanCount
Displays or sets the maximum LSAN count.
SYNOPSIS
DESCRIPTION
fcrlsancount [max_lsan_count]
Use this command to set or display the maximum number of LSAN zones that can be configured on the
edge fabric. By default, the maximum LSAN count is set to 3000, which is also the minimum. This
command allows you to create up to 5000 LSANs on your edge fabric, if needed to support additional
devices. The maximum number of supported LSAN devices is 10,000.
When executed without operand, this command displays the current LSAN zone limit.
This command assumes that all FCRs in the same LSAN fabric matrix or backbone have the same
maximum LSAN count defined in order to protect the FCRs from running into indefinite state. Asymmetric
LSAN configurations due to different maximum LSAN counts may lead to different devices being
imported on different FCRs.
Because the maximum number of LSANs is configured per switch, if there is a different maximum LSAN
count on the switches throughout the meta-SAN, the device import or export will not be identical on the
FCRs. You should therefore enter the same maximum LSAN count for all the FCR switches in the same
backbone that support this feature. Verify the configured maximum limit against the LSANs configured
using the fcrResourceShow command.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
max_lsan_count
Specifies the maximum LSAN count.
EXAMPLES
To display the current LSAN limit:
switch:admin> fcrlsancount
LSAN Zone Limit: 3000
To increase the LSAN zone limit:
switch:admin> fcrlsancount 5000
LSAN Zone Limit: 5000
SEE ALSO
fcrResourceShow
Fabric OS Command Reference
53-1003108-01
341
2
fcrLsanMatrix
fcrLsanMatrix
Creates, modifies, and displays the LSAN fabric matrix or the FCR matrix.
SYNOPSIS
fcrlsanmatrix
fcrlsanmatrix --add -lsan FID FID | -fcr wwn wwn
fcrlsanmatrix --remove -lsan FID FID | -fcr wwn wwn
fcrlsanmatrix --apply -lsan | -fcr | -all
fcrlsanmatrix --cancel -lsan | -fcr | -all
fcrlsanmatrix --display -lsan | -fcr | -all
fcrlsanmatrix --fabricview -lsan | -fcr
fcrlsanmatrix --verify -lsan | -fcr
fcrlsanmatrix --quickmode -lsan | -fcr
fcrlsanmatrix --help
DESCRIPTION
Use this command to create, modify, remove, and manage Logical SAN (LSAN) Zone bindings between
edge fabrics or between FC routers. LSAN Zone bindings specify pairs of edge fabrics or FCRs that can
access each other and share LSAN Zone and device database information.
This command follows a transaction model. Modifications to the LSAN fabric matrix or to the FC router
matrix are saved nonpersistently in a cache until you save the changes persistently with the --apply
option.
When used with the -lsan option, this command manages the LSAN matrix information. An LSAN fabric
pair binds two edge fabrics specified by their Fabric IDs. Every paired edge fabric implies two-way
communications. The paired edge fabrics have access only to the edge fabrics associated with them by
this command. The edge fabrics that are not specified in the LSAN fabric matrix have access to the
remaining unspecified edge fabrics. Using this information, the FCR switch maintains the remote LSAN
Zone and the device state database only if it is associated with its local edge fabrics.
For example, if the edge fabrics with FIDs 1, 2, 3, 4, and 5 are online, all edge fabrics have two-way
communication. This is the default behavior. If you pair the edge fabrics 1 and 2 with the --add -lsan
command, the default access between the edge fabrics is changed as follows:
•
•
•
Fabric 1 can access only fabric 2.
Fabric 2 can access only fabric 1.
The fabrics 3, 4, and 5 can access each other, but cannot access Fabric 1 or 2.
The LSAN matrix information is automatically distributed to all switches in the fabric. The FIDs entered
are not required to be online when you set up the LSAN fabric matrix.
When used with the -fcr option, this command manages the FC router matrix. This database consists of
FC router pairs that can talk to each other. All edge fabrics connected to a defined pair of FCRs are
allowed to import devices to each other.
Once a fabric is removed from an FCR, the communication with other fabrics of the two FCRs is also
removed. It is advisable to update the matrix to reflect the change. If FCR Binding is enabled in the edge
fabrics, the edge fabrics can still communicate with the backbone fabric. The LSAN matrix provides a
higher level of granularity than the FCR matrix. Therefore, communication between two fabrics could
pass the FCR matrix, but fail due to restriction of the FID matrix.
342
Fabric OS Command Reference
53-1003108-01
fcrLsanMatrix
2
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
If no operands are specified, this command displays the persistent LSAN Zone matrix information. The
following operands are optional:
--add -lsan FID FID | -fcr wwn wwn
Adds the pair of edge fabrics or FCR members that can access each other to the
LSAN matrix cache. Edge fabrics are specified by their Fabric IDs. FCRs are
specified by their world wide names (WWNs). If the FCR is online, the domain ID
of the switch can be used in place of the WWN. If you specify --add with zero (0)
value for FID or 00:00:00:00:00:00:00:00 for wwn, the command returns the cache
to default mode.
--remove -lsan FID FID | -fcr wwn wwn
Removes the specified pair of FIDs or FCRs from the cache. When you remove a
fabric or FCR pair from the LSAN matrix, the edge fabrics assume the default
behavior.
--apply -lsan | -fcr | -all
Applies the information from the cache to persistent memory. This operation
succeeds only if there is no effect on the existing import/export devices.
Otherwise, this command generates an error message. See the Diagnostics
section for more information.
--cancel -lsan | -fcr
Cancels changes made to the cache that were not applied. This command
effectively reverts to the persistently stored information.
--display -lsan | -fcr | -all
Displays the information saved in the cache.
--fabricview -lsan | -fcr
Displays all static and default/dynamic fabric bindings in the backbone.
--verify -lsan | -fcr
Verifies if the LSAN Zone information previously entered and stored in the cache
can be successfully applied. The data is considered acceptable if the apply
operation does not cause any traffic disruption
--quickmode
Derives the LSAN Zone matrix from the imported or exported devices.
DIAGNOSTICS
Error message (1)
LSAN Matrix in the cache conflicts with existing import/export devices and may disrupt traffic. Please
refer to the man page for the corrective action.
Corrective actions:
•
Any new router added to the backbone fabric automatically triggers a matrix merge. If a router does
not support the matrix merge feature, the router cannot join the backbone fabric. Make sure that all
legacy FCR switches in the backbone support the matrix merge feature, otherwise the feature is not
supported.
•
Use fcrlsanmatrix --fabricview -lsan | -fcr to confirm that all the switches in the backbone have the
same LSAN and FCR Binding matrix. If not, there are two solutions. The first solution is to modify
one FCR or both to make them the same and then activate the FCRs. The second solution is to zero
out the database of one FCR to signal that this FCR accepts the database from the other FCR once
the change is activated.
Fabric OS Command Reference
53-1003108-01
343
2
fcrLsanMatrix
To zero out the database, execute the following commands:
-
fcrlsanmatrix --add -lsan 0 0
fcrlsanmatrix --add -fcr 00:00:00:00:00:00:00:00 00:00:00:00:00:00:00:00
fcrlsanmatrix --apply -all
•
In a dual backbone configuration, execute fcrlsanmatrix --fabricview on the FCR switches to
confirm that the shared edge fabric FIDs have the same access in both backbones.
•
Execute fcrlsanmatrix --display -lsan | -fcr and fcrproxydevshow -a. Check that the LSAN
Binding matrix in the cache is not in conflict with the existing import/export devices that are displayed
on the FCR switch. If there is a conflict, do one of the following:
-
Update the LSAN/FCR Binding matrix in the cache to allow access for the FIDs that have
imported devices.
-
Remove the conflicting import/export devices by updating the LSAN zone in the edge fabrics.
Disable the conflicting devices.
Error message (2)
There may be other FCR switches in the backbone that do not support the LSAN Binding feature or do
not have the same fcrlsanmatrix settings.
Please refer to the man page for the corrective action.
Corrective actions:
•
•
•
Verify that all FCR switches in the backbone support the LSAN Binding features.
Execute fcrlsanmatrix --fabricview to confirm that all the switches in the backbone have the same
LSAN Binding matrix. If not, clear the LSAN Binding feature on all the switches and reapply the
same LSAN Binding matrix on all the FCR switches in the backbone.
In a dual backbone configuration, use fcrlsanmatrix --fabricview on the FCR switches to confirm
that the shared edge fabric FIDs have the same access in both backbones.
Refer to the Fabric OS Message Reference manual for further diagnostic information.
EXAMPLES
To add the LSAN Zone Matrix data (For the following example, assume that the backbone has the
following online edge fabrics (FIDs): 1, 2, 4, 5, 7, 8, and 10. Currently, FIDs 14 and 19 are not available.):
switch:admin>
switch:admin>
switch:admin>
switch:admin>
fcrlsanmatrix
fcrlsanmatrix
fcrlsanmatrix
fcrlsanmatrix
--add
--add
--add
--add
-lsan
-lsan
-lsan
-lsan
4 5
4 7
10 14
10 19
To remove an entry from the LSAN matrix:
switch:admin> fcrlsanmatrix --remove -lsan 10 14
To display the information from the cache:
switch:admin> fcrlsanmatrix --display -lsan
Fabric ID 1
Fabric ID 2
----------------------------------4
5
4
7
10
19
To apply the changes persistently:
switch:admin> fcrlsanmatrix --apply -lsan
344
Fabric OS Command Reference
53-1003108-01
fcrLsanMatrix
2
To view the persistent changes:
switch:admin> fcrlsanmatrix -lsan
LSAN MATRIX is activated
Fabric ID 1
Fabric ID 2
-------------------------------------4
5
4
7
10
19
To view the LSAN Zone static and default/dynamic binding in the backbone where online fabrics are: 1, 2,
4, 5, 7, 8, 10:
switch:admin> fcrlsanmatrix --fabricview -lsan
LSAN MATRIX is activated
Fabric ID 1
Fabric ID 2
-------------------------------------4
4
10
Default LSAN Matrix:
1 2 8
5
7
19
To display all proxy devices for all FC Routers in the same backbone fabric whether or not they are
relevant to this FC Router:
switch:admin> fcrproxydevshow -a
Proxy
Created
in Fabric
WWN
52 10:00:00:06:2b:0e:4d:e5
52 10:32:16:90:28:dd:d0:03
52 10:32:16:91:24:dd:d0:07
52 10:32:16:91:25:dd:d0:06
78 10:00:00:06:2b:0d:29:31
78 10:32:16:90:29:dd:d0:07
78 10:32:16:91:24:dd:d0:05
78 10:32:16:91:25:dd:d0:03
82 10:00:00:06:2b:0d:29:30
82 10:00:00:06:2b:0d:2f:ed
82 10:00:00:06:2b:0d:33:4d
82 10:00:00:06:2b:0e:4d:c9
Total devices displayed: 12
Proxy
PID
Device Physical
Exists
PID
in Fabric
01f001
0bf001
0bf002
01f002
09f002
08f002
09f001
08f001
01f002
03f002
01f001
03f001
78
82
82
78
52
82
52
82
78
52
78
52
4e0000
2a0900
520c00
4e3000
482200
2a0a00
48a100
520f00
4e1400
480200
4e1800
482000
State
Imported
Imported
Imported
Imported
Imported
Imported
Imported
Imported
Imported
Imported
Imported
Imported
To display the information from the cache:
switch:admin> fcrlsanmatrix --display -lsan
Fabric ID 1
Fabric ID 2
-------------------------------------52
78
52
82
78
82
To apply the changes persistently:
switch:admin> fcrlsanmatrix --apply -lsan
Fabric OS Command Reference
53-1003108-01
345
2
fcrLsanMatrix
To view all the static and the default/dynamic fabric binding in the backbone:
switch:admin> fcrlsanmatrix --fabricview -lsan
LSAN MATRIX is activated
Fabric ID 1
Fabric ID 2
-------------------------------------52
78
52
82
78
82
Default LSAN Matrix:
57 91
To add FCR Bindings to the FCR matrix:
switch:admin> fcrlsanmatrix --add -fcr 10:00:00:60:69:e2:09:fa \
10:00:00:60:69:e2:09:fb
switch:admin> fcrlsanmatrix --add -fcr 10:00:00:60:69:e2:09:fb \
10:00:00:60:69:e2:09:fc
To remove an entry from the FCR matrix:
switch:admin> fcrlsanmatrix --remove -fcr 10:00:00:60:69:e2:09:fb \
10:00:00:60:69:e2:09:fc
To display the information from the cache:
switch:admin> fcrlsanmatrix --display --fcr
CACHE FCR PAIRS
===================================
FCR
FCR
----------------------------------------------------10:00:00:60:69:e2:09:fa (2)
10:00:00:60:69:e2:09:fb (unknown)
To apply the changes persistently:
switch:admin> fcrlsanmatrix --apply -fcr
To view the persistent changes:
switch:admin> fcrlsanmatrix --fabricview -fcr
SAVED FCR PAIRS
===================================
FCR
FCR
----------------------------------------------------10:00:00:60:69:e2:09:fa (2)
10:00:00:60:69:e2:09:fb (unknown)
SEE ALSO
346
fcrFabricShow, lsanZoneShow, fcrPhyDevShow, fcrProxyDevShow, fcrRouteShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrPhyDevShow
2
fcrPhyDevShow
Displays the FC Router physical device information.
SYNOPSIS
DESCRIPTION
fcrphydevshow [-a][-f FID][-w wwn][-c][-d] [-h]
Use this command to display the physical (real) devices that are configured to be exported to other
fabrics. A device is considered to be configured to be exported to another fabric if it is a member of an
LSAN zone. The device is displayed only if it is discovered in the EX_Port-attached fabric and backbone
fabric's name server (for instance, the device is online).
Physical device information is available only for physical devices that exist in fabrics attached to
EX_Ports of FC Routers on the same backbone fabric as the current FC Router.
The default output displays only physical device information relevant to the current FC Router. Relevant
physical devices include physical devices that are configured to be exported from fabrics attached to the
current FC Router's EX_Ports.
The physical devices are listed by fabric.
The -f and -w operands allow searching for physical devices based on fabric ID or port world wide name.
"No device found" is displayed if there is no physical device information available at the current FC
Router.
Each line of the output displays:
Device Exists in Fabric
The fabric in which the physical device exists.
WWN
The world wide name of the device port.
Physical PID
The port ID of the physical device. This port ID is only relevant on the fabric
specified by the "Device Exists in Fabric" column.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-a
Displays all physical devices for all FC Routers in the same backbone fabric
whether or not they are relevant to the current FC Router.
-a -f FID
Displays the physical devices in the specified fabric for all FC Routers in the same
backbone fabric whether or not they are relevant to the current FC Router.
-w wwn
Displays the physical devices with the specified port WWN.
-c
Clears login-related counters.
-d
Displays the following login-related counters. Counters are cleared upon reboot or
failover.
login try
The number of times the device attempted to log in.
Fabric OS Command Reference
53-1003108-01
347
2
fcrPhyDevShow
local failure
the number of times the device login failed because of missing LSAN zones within
the device fabric.
remote failure
the number of times the device login failed due to missing LSAN zones within the
remote fabric.
-h
Displays command usage.
EXAMPLES
To display the physical devices relevant to an FC Router:
fcr:admin> fcrphydevshow
Device
WWN
Physical
Exists
PID
in Fabric
----------------------------------------2
10:00:00:00:c9:2b:6a:68 c70000
3
50:05:07:65:05:84:09:0e 0100ef
3
50:05:07:65:05:84:0b:83 0100e8
Total devices displayed: 3
SEE ALSO
348
fcrFabricShow, fcrProxyDevShow, fcrRouteShow, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrProxyConfig
2
fcrProxyConfig
Displays or configures proxy devices presented by an FC Router.
SYNOPSIS
DESCRIPTION
fcrproxyconfig
[-s importedFID devWWN slot]
[-r importedFID devWWN]
Use this command to display or set the persistent configuration of proxy devices presented by the local
FC Router.
When used without operand, this command displays the persistent proxy device configuration;
otherwise, it sets the specified attributes to its new value.
The proxy device must be inactive prior to setting or clearing persistent attributes. Disabling EX_Ports
(using the portDisable command) attached to the relevant edge fabric, removing the device from the
appropriate LSAN zones, or disabling the physical device are valid methods of ensuring a proxy device is
inactive.
Persistent proxy device configuration attributes apply to the local FC Router. Multiple FC Routers
attached to the same edge fabric coordinate to present the same proxy devices. As a result, persistent
proxy device configurations must be consistent across all FC Routers attached to the same edge fabric
or unpredictable results may occur. If the proxy device configuration is not altered, no action is required.
If the configuration is altered, then care must be taken to ensure consistency across all FC Routers
attached to the same edge fabric.
When used without operands, this command displays the following information:
importedFID
The imported fabric ID of the proxy device.
devWWN
The port world wide name of the device.
Slot
The slot used for the device WWN. The device WWN-to-slot association is
persistently stored. The slot format is XXYYH, where XX specifies the translate
domain area_ID (valid values include F0H through FFH) and YY specifies the Port
ID value or the low 8-bits of the proxy device address (valid values include 01H
through 7FH). The address of the proxy device is derived from the PID format (for
example, native, core, or extended edge) and the proxy device slot.
Fabric OS Command Reference
53-1003108-01
349
2
fcrProxyConfig
If no proxy device WWN is stored in any slot for all edge fabrics, the following message is displayed: "All
slots empty."
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-s importedFID devWWN slot
Adds the specified devWWN (format: xx:xx:xx:xx:xx:xx:xx:xx) to the specified slot
(format XXYYH, where XX is the translate domain area_ID [F0H through FFH]
and YY is the port_ID [01H through 7FH]) for the edge fabric specified (1 through
128). The following messages may be displayed:
•
•
•
"WWN does not exist in any proxy device slot." The WWN does not exist in
any slot for the specified edge fabric.
"Too many proxy slots configured. Remove some unused proxy device
WWNs from their slots using the -r operand and try again." All slots are used
for the specified edge fabric.
"The specified slot already contains a WWN, overwrite? [y]" The specified slot
already contains an entry. You are then prompted for confirmation.
-r importedFID devWWN
Removes the specified devWWN (format: XX:XX:XX:XX:XX:XX:XX:XX) from its
slot for the edge fabric specified by importedFID (1 through 128). If the WWN
does not exist in any slot for the specified edge fabric, the following message is
displayed: "WWN does not exist in any proxy device slot."
EXAMPLES
To display the persistent proxy device configuration:
switch:admin> fcrproxyconfig
Imported FID
Device WWN
002
50:05:07:65:05:84:08:d7
002
50:05:07:65:05:84:0a:7b
002
22:00:00:20:37:c3:11:71
002
22:00:00:20:37:c3:1a:8a
003
10:00:00:00:c9:2b:6a:2c
Slot
f001
f002
f001
f002
f001
To persistently configure device WWN 00:11:22:33:44:55:66:77 to use slot f101h in fabric 5:
switch:admin> fcrproxyconfig -s 5
00:11:22:33:44:55:66:77 f101
\
To remove device WWN 00:11:22:33:44:55:66:77 from its persistent slot in fabric 5:
switch:admin> fcrproxyconfig -r 5 \
00:11:22:33:44:55:66:77
WWN deleted from proxy device slot
SEE ALSO
350
fcrPhyDevShow, fcrProxyDevShow, fcrXlateConfig, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrProxyDevShow
2
fcrProxyDevShow
Displays FC Router proxy device information.
SYNOPSIS
DESCRIPTION
fcrproxydevshow [-a][-f fabricid][-w wwn]
Use this command to display the proxy devices presented by FC Router EX_Ports and information about
the proxy devices. A proxy device is a virtual device presented in to a fabric by an FC Router. A proxy
device represents a real device on another fabric. When a proxy device is created in a fabric, the real
Fibre Channel device is considered to be imported in to this fabric. The presence of a proxy device is
required for inter-fabric device communication. The proxy device appears to the fabric as a real Fibre
Channel device. It has a name server entry and is assigned a valid port ID.
Proxy device information is available only for proxy devices that are presented by FC Routers on the
same backbone fabric as this FC Router.
The default output displays only proxy device information relevant to this FC Router. Relevant proxy
devices include proxy devices created by this FC Router (devices imported by this FC Router).
The proxy devices are listed by fabric. Search parameters -f and -w allow searching for proxy devices
based on fabric ID or port WWN.
"No proxy device found" is displayed if there is no proxy device information available on this FC Router.
This command displays the following information:
Proxy Created in Fabric
The fabric in which the proxy device has been created.
WWN
The WWN of the device port.
Proxy PID
The port ID of the proxy device. The port ID is only relevant on the fabric specified
by the "Proxy Created in Fabric" column.
Device Exists in Fabric
The fabric in which the physical device represented by this proxy device exists.
Physical PID
The port ID of the physical device. The port ID is relevant only on the fabric
specified by the "Device Exists in Fabric" column.
State
State includes:
Imported
Proxy device has been imported into the fabric.
Initializing
The proxy device is being initialized and will soon be imported into the fabric.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-a
Display all proxy devices for all FC Routers in the same backbone fabric whether
or not they are relevant to this FC Router.
Fabric OS Command Reference
53-1003108-01
351
2
fcrProxyDevShow
-a -f fabricid
Display the proxy devices in the specified fabric for all FC Routers in the same
backbone fabric whether or not they are relevant to this FC Router.
-f fabricid
Display the proxy devices in the specified fabric that are relevant to this FC
Router.
-w wwn
Displays proxy devices with the specified port WWN.
EXAMPLES
To display the proxy devices relevant to this FC Router:
switch:admin> fcrproxydevshow
Proxy
WWN
Proxy Device Physical State
Created
PID
exists
PID
in Fabric
in Fabric
--------------------------------------------------------2
50:05:07:65:05:84:09:0e 01f001
3
0100ef Imported
2
50:05:07:65:05:84:0b:83 01f000
3
0100e8 Imported
3
10:00:00:00:c9:2b:6a:68 02f000
2
c70000 Imported
Total devices displayed: 3
SEE ALSO
352
fcrFabricShow, fcrRouteShow, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrResourceShow
2
fcrResourceShow
Displays FC Router physical resource usage.
SYNOPSIS
DESCRIPTION
fcrresourceshow
Use this command to display the FC Router-available resources. The maximum number allowed versus
the currently used is displayed for various resources. The command output includes:
LSAN Zones
The maximum versus the currently used LSAN zones.
LSAN Devices
The maximum versus the currently used LSAN device database entries. Each
proxy or physical device constitutes an entry.
Proxy Device Slots
The maximum versus the currently used proxy device slots. A proxy device is
presented to an edge fabric as being connected to a translate domain slot. A slot
is the port number and AL_PA combination. The slot-to-device WWN association
is persistently stored.
Phantom Node WWNs
The maximum versus the currently allocated phantom switch node WWNs. The
phantom switch requires node WWNs for fabric-shortest-path-first (FSPF) and
manageability purposes. Phantom node names are allocated from the pool
sequentially and are not reused until the pool is exhausted and rolls over. The last
allocated phantom node WWN is persistently stored. If the switch is disabled, the
phantom node WWNs are not returned to the pool until the system reboots,
because the phantom switch could still be accessible through other switches.
Across a switch reboot, the allocation starts from the next usable WWN from the
pool and not from the beginning.
Phantom Port WWNs
The maximum versus the currently used phantom domain port WWNs. Phantom
domain ports require port WWNs for manageability purposes. Phantom domain
ports include ports connecting front and translate domains (virtual ISLs), translate
domain ports for proxy devices, and EX_Ports. Phantom port names are allocated
from the pool sequentially and are not resumed until the pool is exhausted and
rolls over. The last allocated phantom port WWN is persistently stored. If the
switch is disabled, phantom port WWNs are not returned to the pool until the
system reboots, because the phantom switch might still be accessible through
other switches. Across the switch reboot, the allocation starts from the next usable
WWN base from the pool and not from the beginning.
Port Limits
Displays resources for each physical port (EX_Port), which include the following:
Max Proxy Devices
The maximum versus the currently used proxy device.
Max NR_Ports
The maximum versus the currently used NR_Port entries. Destination NR_Port
entries are stored at every physical port for routing decision purposes.
NOTES
Only configured EX/VEX_Ports are displayed
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Fabric OS Command Reference
53-1003108-01
353
2
fcrResourceShow
OPERANDS
None
EXAMPLES
To display the resource usage for the local FC Router:
switch:admin> fcrresourceshow
Daemon Limits:
Max Allowed Currently Used
---------------------------LSAN Zones:
3000
22
LSAN Devices:
10000
1208
Proxy Device Slots: 10000
2
WWN Pool Size
Allocated
---------------------------Phantom Node WWN:
8192
3790
Phantom Port WWN: 32768
6446
Port Limits:
Max proxy devices:
Max NR_Ports:
2000
1000
Currently Used(column 1: proxy, column 2: NR_Ports):
48 |
0
0
49 |
0
0
50 |
0
0
52 |
0
0
53 |
0
0
54 |
0
0
60 |
0
0
63 |
1
4
176 |
1
4
177 |
1
4
183 |
1
4
190 |
0
0
SEE ALSO
354
fcrFabricShow, fcrProxyDevShow, fcrRouteShow, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
fcrRouterPortCost
2
fcrRouterPortCost
Displays or sets an FC Router port cost.
SYNOPSIS
DESCRIPTION
fcrrouterportcost [[slot/]port] [cost]
Use this command to set or display the cost of the FC Router ports. You can set the cost of the link to one
of two fixed values: 1000 or 10000. The option 0 sets the cost of the link to the default value based on
link type (EX/VEX). The router module chooses the router port path based on the minimum cost per
fabric ID (FID) connection. If multiple paths exist with the same minimum cost, the load is shared over
these paths.
Every inter-fabric link (IFL) has a default cost. For an EX_Port IFL, the default cost is 1000. For a
VEX_Port, the default cost is 10000. If the cost is set to 0, the link cost defaults to 1000 for an EX_Port
and to 10000 for a VEX_Port.
when used without operands, this command displays the current link costs for all ports on the switch.
NOTES
Before setting the cost, ensure that admin is enabled for the EX_Port/VEX_Port with portCfgEXPort or
portCfgVEXPort. The cost can be set only on a disabled port.
The bandwidth of an inter-fabric link (IFL) is unrelated to its default cost. In other words, 1 Gbps, 2 Gbps,
4 Gbps, and 8 Gbps EX_Port IFLs have the same cost value of 1000 as their FC Router port.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
slot
For bladed systems only, specifies the slot number of the port whose cost is to be
displayed or changed, followed by a slash (/).
port
Specifies the number of the port whose cost is to be displayed or changed. This
value is relative to the slot for bladed systems. Use switchShow for a list of valid
ports. If a port is not specified, this command displays the costs of all ports.
cost
Specifies the new cost of the link connected to the specified port. This operand is
optional; if omitted, this command displays the cost of the specified port. The cost
of the link can be changed only when the specified port is disabled. Valid values
for cost are 0, 1000 or 10000.
EXAMPLES
To display the cost of all EX_Ports:
switch:admin> fcrrouterportcost
Port
Cost
-----------------------7/3
1000
7/4
1000
7/9
1000
7/10
1000
7/16
10000
10/0
10000
Fabric OS Command Reference
53-1003108-01
355
2
fcrRouterPortCost
To display the cost on an EX_Port:
switch:admin> fcrrouterportcost 7/10 0
switch:admin> fcrrouterportcost 7/10
Port
Cost
-----------------------7/10
1000
To set the cost of an EX_Port and display the result:
switch:admin> fcrrouterportcost 7/10 10000
switch:admin> fcrrouterportcost 7/10
Port
Cost
-----------------------7/10
10000
To set the default cost on the EX_Port:
switch:admin> fcrrouterportcost 7/10 0
switch:admin> fcrrouterportcost 7/10
Port
Cost
-----------------------7/10
1000
SEE ALSO
356
switchShow, fcrRouteShow, portCfgEXPort
Fabric OS Command Reference
53-1003108-01
fcrRouteShow
2
fcrRouteShow
Displays FC Router route information.
SYNOPSIS
DESCRIPTION
fcrrouteshow
Use this command to display routes through the FC Router backbone fabric to accessible destination
fabrics. An FC Router backbone fabric is the fabric that contains the E_Ports of this platform and routes
inter-fabric traffic between imported fabrics, creating a meta-SAN.
There are FC Router ports that reside on the backbone fabric. These ports are known as NR_Ports.
NR_Ports send and receive inter-fabric traffic. For the AP7420, there is a one-to-one relationship
between an NR_Port on a backbone fabric and an EX_Port. NR_Port technology enables EX_Ports to
exchange traffic across an intermediate fabric. NR_Ports are addressable entities on the backbone fabric
and have port IDs relevant to the backbone fabric.
Because cascaded backbone/intermediate fabrics are currently not supported, an NR_Port provides a
path to a single fabric with a single FC Router protocol cost. Multiple NR_Ports can provide paths to the
same destination fabric.
"No routes found" is displayed if there is no route information available at this FC Router. There is no
route information available if no EX_Ports are configured at this FC Router.
The output includes:
Destination Fabric ID
The destination fabric.
NR_Port PID
The port ID of the NR_Port. The port ID is relevant only on the backbone fabric.
This NR_Port has a route to the destination fabric identified by the "Destination
Fabric ID" column.
FCRP Cost
The FC Router protocol cost (for routing decisions) for this NR_Port. The FCRP
cost is the same (1000) for all NR_Ports.
WWN of the Principal Switch in the Dest. Fabric
The world wide name of the principal switch in the destination fabric.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the route information:
switch:admin> fcrrouteshow
Destination NR_Port
FCRP Cost WWN of Principal
Fabric Id
PID
Switch in the Dest. Fabric
--------------------------------------------------------4
640000
1000
10:00:00:60:69:c0:05:d1
4
640100
1000
10:00:00:60:69:c0:05:d1
5
640200
1000
10:00:00:60:69:c0:20:ed
5
640300
1000
10:00:00:60:69:c0:20:ed
SEE ALSO
fcrFabricShow, fcrPhyDevShow, fcrProxyDevShow, lsanZoneShow, switchShow
Fabric OS Command Reference
53-1003108-01
357
2
fcrXlateConfig
fcrXlateConfig
Configures a translate (xlate) domain's domain ID and state of persistence for both the EX_Port-attached
fabric and the backbone fabric.
SYNOPSIS
fcrxlateconfig
fcrxlateconfig importedFID exportedFID preferredDomainID
fcrxlateconfig --remove | -r importedFID exportedFID
fcrxlateconfig --enable persistxd
fcrxlateconfig --disable persistxd
fcrxlateconfig --show stalexd importedFID
fcrxlateconfig --delete stalexd importedFID staleXlateDomainID
fcrxlateconfig --help
DESCRIPTION
Use this command to display a translate (xlate) domain ID or change the preferred domain ID and its
state of persistence.
A translate domain is a phantom domain created by an FC Router. FC Routers emulate proxy devices
representing real devices in remote fabrics. These proxy devices are emulated to be connected to
translate domains. Translate domains are presented to a fabric as residing topologically behind front
phantom domains (domains created by an EX_Port). In the case of backbone fabrics, translate domains
are topologically behind an E_Port. In every EX_Port-attached edge fabric and backbone fabric, there
can be a translate domain for every FC Router-accessible remote fabric.
During a fabric build, the translate domain requests a domain ID from the principal switch in the
EX_Port-attached edge fabric. The domain ID requested is the preferred domain ID. You can set the
preferred domain ID when the translate domain is not active and is persistently saved. The principal
switch attempts to provide the translate domain with the requested domain ID, but it may not provide it if
there are domain ID conflicts with other domains in the fabric. If the requested domain ID (such as the
preferred domain ID) is unavailable, the domain ID assignment is completely at the discretion of the
principal switch. The assignment domain ID is persistently stored and is used as the preferred domain ID
in the future.
By default, FCR creates the translate domain for a remote fabric if a valid persistent translate domain ID
is configured in the local fabric, even if no devices are imported or exported across the edge fabrics.
Disabling the persistxd parameter prevents the xlate domain from being created. Enabling the
persistxd parameter from a disabled state re-enables the FCR default behavior.
If the remote edge fabric becomes unreachable, the translate domains created in other edge fabrics for
this remote edge fabric become stale. Use the --show stalexd option to identify translate domains that
have become stale, and delete them in a nondisruptive manner with the --delete stalexd option.
When executed without operands, fcrxlateconfig displays for each translate domain the imported FID,
the exported FID, the domain ID and the xlate WWN.
358
Fabric OS Command Reference
53-1003108-01
fcrXlateConfig
NOTES
2
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
Information displayed is not related to the entire backbone. The FC Router displays only connections to
an edge fabric for which there are translate domain IDs. Any changes you intend to make using this
command should be issued on the switches to which the edge fabrics are directly attached. In a Virtual
Fabric environment, this is the base switch.
OPERANDS
This command has the following operands:
fcrxlateconfig
Sets the preferred domain ID (1-239) to preferredDomainID for the translate
phantom domain and saves the configuration persistently. The translate domain
must be inactive to set the preferred domain ID. The following operands are
required:
importedFID
Specifies the fabric ID (1 through 128) of the fabric that contains the translate
domain.
exportedFID
Specifies the fabric ID (1 through 128) of the remote fabric represented by this
translate domain.
preferredDomainID
Specifies the preferred domain ID (1 through 239) of the translate phantom
domain.
--remove | -r
Removes the preferred domain ID of the translate phantom domain. The translate
domain must be inactive to remove the preferred domain ID. The following
operands are required:
importedFID
Specifies the fabric ID (1 through 128) of the fabric that contains the translate
domain.
exportedFID
Specifies the fabric ID (1 through 128) of the remote fabric represented by this
translate domain.
preferredDomainID
Specifies the preferred domain ID (1 through 239) of the translate phantom.
--enable persistxd
Enables translate domain persistence. When persistxd is enabled, the translate
domain is created based on the persistent translate domain ID configuration. If a
valid persistent translate domain ID is configured for a given importedFID and
exportedFID pair, a translate domain for the exportedFID is created, even if no
devices need to be imported or exported across the edge fabrics represented by
importedFID and exportedFID. By default, persistxd is enabled.
--disable persistxd
Disables translate domain persistence. When persistxd is disabled, the translate
domain is not created, even if a valid persistent translate domain ID is configured
for the importedFID and exportedFID pair, so long as no devices are imported or
exported across the edge fabrics represented by importedFID and exportedFID.
Once devices need to be imported or exported across the edge fabrics, the
translate domain is created.
Fabric OS Command Reference
53-1003108-01
359
2
fcrXlateConfig
--show stalexd [importedFID]
Displays stale translate domains associated with the specified Fabric ID (1-128).
A translate domain becomes stale when the remote edge fabric for which this
translate domain was created in the specified edge fabric becomes unreachable.
When issued without specifying an imported FID, this command lists all stale
translate domains in all edge fabrics connected to the FCR.
--delete stalexd importedFID staleXlateDomainID
Deletes the specified stale translate domain from the edge fabric specified by its
fabric ID. This command must be executed in the FCR that owns the stale
translate domain.
EXAMPLES
To display the translate domain configuration and the state of the persistxd parameter:
switch:admin> fcrxlateconfig
ImportedFid ExportedFid
001
002
001
005
Domain
004
003
OwnerDid
000001
N/A
XlateWWN
N/A
N/A
Persist XD state: Enabled
To set the preferred domain ID of the translate domain created in fabric 2, which represents the remote
fabric 3, to a value of 8:
switch:admin> fcrxlateconfig 2 3 8
xlate domain already configured, overwrite?(n) y
To clear the preferred domain ID of the translate domain created in fabric 2, which represents remote
fabric 3:
switch:admin> fcrxlateconfig -r 2 3
xlate domain deleted
To enable translate domain persistence:
fcr:admin> fcrxlateconfig --enable persistxd
Persist XD is enabled
To disable translate domain persistence:
fcr:admin> fcrxlateconfig --disable persistxd
Persist XD is disabled
To identify and remove stale translate domains in a single backbone multiple FCR configuration:
fcr:admin> fcrxlateconfig --show stalexd
Imported FID
Stale XD
Owner Domain
-------------------------------------------------012
002
007 ( this FCR )
013
002
001 ( other FCR )
To remove the stale translate domain (only the translate domain owned by the current owner can be
removed; note that trailing zeros must be removed from the FID and Xlate domain ID.>):
fcr:admin> fcrxlateconfig --delete stalexd 12 2
Xlate domain 2 is deleted
SEE ALSO
360
portCfgEXPort, portCfgVEXPort, portDisable, portEnable, portShow
Fabric OS Command Reference
53-1003108-01
fddCfg
2
fddCfg
Manages the fabric data distribution configuration parameters.
SYNOPSIS
fddcfg --showall
fddcfg --localaccept policy_list
fddcfg --localreject policy_list
fddcfg --fabwideset policy_list
DESCRIPTION
Use this command to manage the fabric data distribution configuration parameters. These parameters
control the fabric-wide consistency policy.
Switches can be locally configured to allow or reject a security policy. Supported policies include the
following:
SCC
Switch Connection Control policy
DCC
Device Connection Control policy
SCC
Switch Connection Control policy
PWD
Password policy
FCS
Fabric Configuration Server policy
PWD
Fabric Element Authentication policy
IPFILTER
IP Filter policy
Automatic distribution of a fabric-wide consistency policy is limited to SCC, DCC, and FCS policies. Use
the --fabwideset parameter to enforce these policies fabric-wide in tolerant or strict mode, In strict mode,
fabric-wide enforcement of FCS consistency policy is possible in mixed fabrics. However, switches that
do not support the policies ignore them.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--showall
Displays the accept/reject configuration of all policy sets and the fabric-wide
consistency policy on the switch.
--localaccept policy_list
Configures the switch to accept distributions of the specified policies. The policies
in policy_list must be separated by semicolons and enclosed in quotation marks;
for example, "SCC;DCC;FCS".
Fabric OS Command Reference
53-1003108-01
361
2
fddCfg
--localreject policy_list
Configures the switch to reject distributions of the specified policies in policy_list.
However, a database cannot be rejected if it is specified in the fabric-wide
consistency policy. The policies in policy_list must be separated by semicolons
and enclosed in quotation marks; for example, "SCC;DCC".
--fabwideset policy_list
Sets the fabric-wide consistency policy. A database that is set to reject
distributions cannot be specified in the fabric-wide consistency policy. To set the
fabric-wide consistency policy as strict, use the strictness indicator "S". To set the
fabric-wide consistency policy as tolerant, omit the "S". A valid policy set should
be of the form "SCC:S;DCC;FCS". To set the fabric-wide policy to NULL (default)
or no fabric-wide consistency, use the policy Set "". Supported policies are Switch
Connection Control (SCC), Device Connection Control (DCC), and Fabric
Configuration Server (FCS). All members specified in a given policy set are
automatically distributed to all participating switches in the fabric that support the
policy. Refer to the DESCRIPTION section for specific exceptions. In the
presence of a fabric-wide FCS consistency policy, this command can only be run
from the primary FCS switch.
EXAMPLES
To display the fabric-wide consistency policy and the accept/reject configuration for all databases:
switch:admin> fddcfg --showall
Local Switch Configuration for all Databases:DATABASE - Accept/Reject
------------------------SCC accept
DCC accept
PWD accept
FCS accept
AUTH accept
IPFILTER accept
Fabric Wide Consistency Policy:- "SCC:S;DCC;FCS"
To configure the switch to accept distribution of the SCC policy set and PWD database:
switch:admin> fddcfg --localaccept "SCC;PWD"
Local Switch Configured to accept policies.
To configure this switch to reject distribution of SCC and DCC policy sets:
switch:admin> fddcfg --localreject "SCC;DCC"
Local Switch Configured to reject policies.
To set the fabric-wide consistency policy to "strict" for SCC and "tolerant" for DCC and FCS:
switch:admin> fddcfg --fabwideset "SCC:S;DCC;FCS"
SEE ALSO
362
distribute
Fabric OS Command Reference
53-1003108-01
fdmiCacheShow
2
fdmiCacheShow
Displays abbreviated remote FDMI device information, according to remote domain ID.
SYNOPSIS
DESCRIPTION
fdmicacheshow
Use this command to display FDMI cache information for remote domains only.
The state of each remote domain, identified by its domain ID, is shown to be unknown, known,
unsupported, or error.
The revision of the switch also displays, followed by the world wide name of the switch.
For HBAs, only the HBA identifiers and registered port lists are displayed. No detailed HBA attributes are
displayed. For registered ports, only port identifier and corresponding HBA are shown; no detailed port
attributes are displayed.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the FDMI cache:
switch:admin> fdmicacheshow
Switch entry for domain 3
state:
known
version: v310
wwn:
10:00:00:60:69:90:03:c7
HBAs:
10:00:00:00:c9:25:9b:96
Ports: 1
10:00:00:00:c9:25:9b:96
Total count of devices on the switch is 1
SEE ALSO
fdmiShow
Fabric OS Command Reference
53-1003108-01
363
2
fdmiShow
fdmiShow
Displays detailed FDMI information.
SYNOPSIS
DESCRIPTION
fdmishow
Use this command to display Fabric-Device Management Interface (FDMI) information for all Host Bus
Adapters (HBAs) and ports.
Detailed FDMI information is displayed for local HBAs and ports.
Only abbreviated FDMI information is shown for HBA and ports on remote switches.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display FDMI information on a local switch:
switch:admin> fdmishow
Local HBA database contains:
10:00:8c:7c:ff:01:eb:00
Ports: 1
10:00:8c:7c:ff:01:eb:00
Port attributes:
FC4 Types:
0x0000010000000000000000000000000000000000000000000000000000000000
Supported Speed: 0x0000003a
Port Speed: 0x00000020
Frame Size: 0x00000840
Device Name: bfa
Host Name: X3650050014
Node Name: 20:00:8c:7c:ff:01:eb:00
Port Name: 10:00:8c:7c:ff:01:eb:00
Port Type: 0x0
Port Symb Name: port2
Class of Service: 0x08000000
Fabric Name: 10:00:00:05:1e:e5:e8:00
FC4 Active Type:
0x0000010000000000000000000000000000000000000000000000000000000000
Port State: 0x00000005
Discovered Ports: 0x00000002
Port Identifier: 0x00030200
HBA attributes:
Node Name: 20:00:8c:7c:ff:01:eb:00
Manufacturer: Brocade
Serial Number: BUK0406G041
Model: Brocade-1860-2p
Model Description: Brocade-1860-2p
Hardware Version: Rev-A
Driver Version: 3.2.0.0705
Option ROM Version: 3.2.0.0_alpha_bld02_20120831_0705
Firmware Version: 3.2.0.0_alpha_bld02_20120831_0705
OS Name and Version: Windows Server 2008 R2 Standard | N/A
Max CT Payload Length: 0x00000840
Symbolic Name: Brocade-1860-2p | 3.2.0.0705 | X3650050014 |
364
Fabric OS Command Reference
53-1003108-01
fdmiShow
2
Number of Ports: 2
Fabric Name: 10:00:00:05:1e:e5:e8:00
Bios Version: 3.2.0.0_alpha_bld02_20120831_0705
Bios State: TRUE
Vendor Identifier: BROCADE
Vendor Info: 0x31000000
Local Port database contains:
10:00:8c:7c:ff:01:eb:00
Remote HBA database contains:
10:00:00:05:1e:ea:05:fa
Ports: 1
10:00:00:05:1e:ea:05:fa
Remote Port database contains:
10:00:00:05:1e:ea:05:fa
SEE ALSO
fdmiCacheShow
Fabric OS Command Reference
53-1003108-01
365
2
ficonCfg
ficonCfg
Configures the specified FICON database.
SYNOPSIS
ficoncfg --set database port
ficoncfg --reset database
ficoncfg --help
DESCRIPTION
NOTES
OPERANDS
Use this command to configure a FICON database on a specified port. Refer to ficonShow for a
description of the database content.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
port
Specifies the port to be configured. You can specify the port by its port index
number or by a hexadecimal number that contains the Area field (middle byte) of
the three-byte Fibre Channel Port Address. Use switchShow for a listing of valid
port index numbers.
--set
Sets the configuration entry.
--reset
Resets the configuration entry to its default value.
database
Specifies the name of the FICON database. The only database currently
supported is the following:
LIRR
Devices registered to receive link incident reports.
EXAMPLES
To set the LIRR database on a port using a decimal index number:
switch:user> ficoncfg --set LIRR 27
To reset the LIRR
switch:user> ficoncfg --reset LIRR
To set the LIRR database using a hexadecimal index number that contains the Area field (middle byte) of
the three-byte Fibre Channel Port Address:
switch:user> ficoncfg --set LIRR 0x1b
switch:user> ficonshow LIRR
The Local LIRR database has 0 entries.
Current LIRR device port number: 27 (0x1b)
SEE ALSO
366
ficonHelp, ficonShow
Fabric OS Command Reference
53-1003108-01
ficonClear
2
ficonClear
Clears the records from the specified FICON database.
SYNOPSIS
DESCRIPTION
NOTES
OPERANDS
ficonclear database
Use this command to remove records from the local FICON database. The command effect depends on
the specified database.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
database
Specifies the name of the FICON database. The databases include the following:
RLIR
Remove all entries from the link incidents database including implicit link incidents
(ILIR).
RNID
Remove all the "not current" entries from the device node identification database
(the entries are for devices that were previously connected but are no longer
online). Note that "current" entries are not removed from the RNID database.
EXAMPLES
To clear the RLIR database:
switch:user> ficonclear RLIR
successfully clear local RLIR Database.
To clear the RNID database:
switch:user> ficonclear RNID
successfully clear not current
entries from local RNID Database.
SEE ALSO
ficonHelp, ficonShow
Fabric OS Command Reference
53-1003108-01
367
2
ficonCupSet
ficonCupSet
Sets FICON-CUP parameters for a switch.
SYNOPSIS
ficoncupset fmsmode enable | disable
ficoncupset modereg bitname 0 | 1
ficoncupset MIHPTO seconds
ficoncupset CRP PID CHID
DESCRIPTION
Use this command to set FICON-CUP (Control Unit Port) parameters for a switch. All parameters can be
set while the switch is online. Changes made by this command take effect immediately. A reboot is not
required.
Use ficonCupShow to display current settings.
NOTES
A FICON License is required to enable FMSMODE and to manage ports with FICON CUP. Without a
license, FICON CUP traffic will not be allowed.
When FMSMODE is enabled, port names are truncated to 24 characters to be FICON compliant, and a
24-character limit is imposed on all newly created port names.
FICON Management Server (FMS) mode cannot be enabled if port ID (PID) Format 2 is used. Refer to
the Fabric OS Administrator's Guide for information on PID formats.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
fmsmode
Configures the FICON Management Server (FMS) mode for the switch. Specify
one of the following modes:
enable
Enables the FICON Management Server mode. When you enable the switch, you
must wait until all ports have come online before enabling fmsmode.
disable
Disables the FICON Management Server mode.
modereg
Set a bit in the FICON-CUP mode register. The following operands are required:
bitname 0 | 1
Specifies a given bit value to be (1) set or not set (0). Valid values for bitname are
POSC
Programmed offline state control
ASM
Active=saved mode
DCAM
Director clock alert mode
ACP
Alternate control prohibited
368
Fabric OS Command Reference
53-1003108-01
ficonCupSet
2
HCP
Host control prohibited
MIHPTO
Sets the missing interrupt handler primary timeout (MIHPTO) value for the CUP.
The following operand is required:
seconds
Specifies the timeout value in seconds. Provide a decimal value in the range
between 15 and 600 seconds. The default timeout value is 180 seconds. If a value
greater than 63 seconds is specified, the timeout value is rounded down to the
closest value divisible by 10. For example, an MIHPTO timeout value of 86
defaults to 80.
CRP PID CHID
Sets the current reporting path (CRP). The reporting path is a CUP mechanism for
sending FRU-failure reports to a FICON logical path via FICON protocol. The
logical path between the PID and the CHID must exist and be in operational state
for this command to succeed. Use ficonCupShow with the LP option to display the
logical paths on the switch. The following operands are required:
PID
Specifies the Port identifier, which is a three-byte Fibre Channel Port Address.
CHID
Specifies the Channel ID (CHID). The CHID is the Logical Partition (LPAR)
identifier supplied as part of the FICON protocol header. The CHID is a 1-byte
value in hexdecimal format. The first nibble indicating the Channel Subsystem
identifier (a value between 0 and 3) and the second the LPAR within that CSS (a
value between 0 and F).
EXAMPLES
To enable FMS mode for the switch:
switch:admin> ficoncupset fmsmode enable
fmsmode for the switch is now Enabled
To set the ASM bit in the mode register for the switch:
switch:admin> ficoncupset modereg ASM 1
Active=Saved Mode bit is set to 1
To set the MIHPTO value to 60 seconds:
switch:admin> ficoncupset MIHPTO 60
MIHPTO has been changed to 60 seconds
To set the current reporting path:
switch:admin> ficoncupset CRP 082300 1A
To display the current reporting path:
switch:admin> ficoncupshow LP
FICON CUP Logical Paths for CUP 0x08FE00
PID
-----082300
082300
Fabric OS Command Reference
53-1003108-01
LP
CHID
---1A
1B
Reporting
State
---Oper***
Oper
Path
-----Curr
369
2
ficonCupSet
082300
082400
082400
612400
612400
SEE ALSO
370
1C
1A
1B
1E
1F
Oper
Reset
Reset
Reset
Reset
Prim
ficonCupShow
Fabric OS Command Reference
53-1003108-01
ficonCupShow
2
ficonCupShow
Displays FICON-CUP parameters for a switch.
SYNOPSIS
ficoncupshow fmsmode
ficoncupshow modereg [bitname]
ficoncupshow MIHPTO
ficoncupshow DD_LOG
ficoncupshow diag_info
ficoncupshow hlthchk_log
ficoncupshow LP
DESCRIPTION
NOTES
OPERANDS
Use this command to display FICON-CUP (Control Unit Port) parameters for a switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
fmsmode
Display the FICON Management Server (FMS) mode for the switch.
modereg
Display the FICON-CUP mode register. If no operand is specified, all mode
register bit settings are displayed. If a mode register bit name is specified, then
only the value of that bit is displayed. A value of 1 indicates that a given mode
register bit is set, and 0 indicates that it is not set.
The following operand is optional:
bitname
Displays the specified mode register bit as either set (1) or not set (0). Valid values
for bitname include the following:
POSC
Programmed offline state control
UAM
User alert mode
ASM
Active=saved mode
DCAM
Director clock alert mode
ACP
Alternate control prohibited
HCP
Host control prohibited
Fabric OS Command Reference
53-1003108-01
371
2
ficonCupShow
MIHPTO
Displays the FICON-CUP missing interrupt handler primary timeout (MIHPTO)
value in seconds.
DD_LOG
Displays the latest Director Diagnostics Log.
diag_info
Displays dignostic information for the logical switch such as whether Diagnostic
Interval has been set for CUP Diagnostics (if so, then Statistics Sampling is
running), along with additional information about Statistics Sampling by the CUP,
the detected CUP Diagnostic capabilities and settings for other switches in the
fabric..
hlthchk_log
Displays the HealthCheck Logs for the logical switch. It displays Sense Data
returned to the FICON host for Asynchronous Error Reporting events generated
by the CUP for Congestion, Latency, or Port Fencing events which have been
detected by the switch.
LP
Displays the logical paths on the switch. For each entry, the command displays
the port identifier (PID), the LPAR identifier (CHID), reporting state (operational or
reset (=nonoperational)), and reporting path state (current, primary, or alternate).
EXAMPLES
To display the FMS mode for the switch:
switch:user> ficoncupshow fmsmode
fmsmode for the switch: Enabled
To display the mode register for the switch:
switch:user> ficoncupshow modereg
POSC UAM ASM DCAM ACP HCP
-----------------------------1
0
1
1
1
0
To display the ASM bit in the mode register for the switch:
switch:user> ficoncupshow modereg ASM
ASM
--1
To display the MIHPTO value for the CUP:
switch:user> ficoncupshow MIHPTO
MIHPTO for the CUP: 60 seconds
To display the logical paths for the switch:
switch:user> ficoncupshow LP
FICON CUP Logical Paths for CUP 0x08FE00
LP
Operational Reporting
PID
CHID
State
Path State
------ -----------082300 1A
Oper***
Current
082300 1B
Oper
372
Fabric OS Command Reference
53-1003108-01
ficonCupShow
082300
082400
082400
612400
612400
SEE ALSO
1C
1A
1B
1E
1F
Oper
Reset
Reset
Reset
Reset
2
Primary
ficonCupSet, ficonHelp
Fabric OS Command Reference
53-1003108-01
373
2
ficonHelp
ficonHelp
Displays a list of FICON support commands.
SYNOPSIS
DESCRIPTION
NOTES
ficonhelp
Use this command to display a list of FICON support commands with descriptions.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display a list of FICON commands:
switch:admin> ficonhelp
ficoncfg
Manage FICON configuration
ficonclear
Clears contents of the specified FICON
management database
ficoncupset
Sets FICON-CUP parameters for a switch
ficoncupshow
Displays FICON-CUP parameters for a switch
ficonhelp
Displays FICON commands
ficonshow
Displays contents of the specified FICON
management database
SEE ALSO
374
None
Fabric OS Command Reference
53-1003108-01
ficonShow
2
ficonShow
Displays the contents of the specified FICON database.
SYNOPSIS
DESCRIPTION
ficonshow database [fabric | table | port port_index]
Use this command to display the contents of a FICON database. The ficonShow database operand is
the name of the database to display. If the fabric operand is absent, the command displays the members
of the named database that are local to the switch on which the command was issued. If the fabric
operand is present, it must be entered exactly as shown, and this specifies that all members are
displayed, both local and remote.
The following information may be displayed, depending on which database you enter and which
operands you use with the command:
Domain
Displays the domain ID.
Fabric WWN
Displays the fabric WWN.
Flag
Indicates if the node is valid, not valid, or not current. Flag values are as follows:
0x00
Indicates the node ID of the storage port is valid.
0x10
Indicates the node ID of the channel port is valid.
0x20
Indicates the node ID of the storage port is not current.
0x30
Indicates the node ID of the channel port is not current.
0x40
Indicates the node ID of the storage port for the RNID switch for RLIR is not valid.
0x50
Indicates the node ID of the channel port is not valid.
Fmt
Displays the record-registration format.
FRU Failure Description
Indicates the FRU failure type as one of the following:
WWN card [unit number]
The WWN card
Power Supply [unit number]
The Power Supply card
Hardware Slot [unit number]
The Hardware Slot
Blower [unit number]
The Blower
FRU Part Number
Displays the FRU part number.
FRU Serial Number
Displays the FRU serial number.
Fabric OS Command Reference
53-1003108-01
375
2
ficonShow
Incident Count
Displays the incident count. This number increases by 1 for each incident within
the individual switch.
Link Incident Description
Same as Link Incident Type.
Link Incident Type
Indicates the link incident type as one of the following:
•
•
•
•
•
Bit-error-rate threshold exceeded
Loss of signal or synchronization
NOS recognized
Primitive sequence timeout
Invalid primitive sequence for port state
Listener PID
Same as PID.
Listener Port Type
Same as Port Type.
Listener Port WWN
Displays the channel HBA port world wide name.
Listener Type
Indicates the listener type as follows:
Conditional
This port receives a link incident record if no other recipients from the established
registration list have been chosen.
Unconditional
This port is always chosen as a recipient of a link incident record.
Manufacturer
Displays the manufacturer name or code.
Model Number
Displays the model number.
Node Parameters
Same as Parameters.
Parameters
Displays the node type for the switch in three bytes, 0xAABBCC:
Byte AA 0x20
FC-SB-2 and updates
Byte BB 0x0a
Switch
Byte CC 0x00
Port number. It is dynamically assigned whenever a link incident occurs.
Parm
Displays the incident node parameters type in three bytes, 0xAABBCC:
Byte AA
Possible values include the following:
0x00
Reserved.
0x20
FC-SB-2 and updates.
376
Fabric OS Command Reference
53-1003108-01
ficonShow
2
0x40
Other FC-4s including FCP and updates.
0x60
FC-SB-2 and updates and other FC-4s including FCP and updates.
0x80
FC-4 support not specified.
0xa0
Reserved.
0xc0
Reserved.
0xe0
Vendor-specific.
Byte BB
Possible values include the following:
0x00
Unspecified class.
0x01
Direct access storage device, if it is a storage port; otherwise, not
channel-to-channel capable.
0x02
Magnetic tape, if it is a storage port; otherwise, a reserved field for a channel
port.
0x03
Input unit record, if it is a storage port; otherwise, a reserved field for a
channel port.
0x04
Output unit, if it is a storage port; otherwise, a reserved field for a channel
port.
0x05
Reserved field for a channel port.
0x06
Controller, if it is a storage port; otherwise, a reserved field for a channel port.
0x07
Terminal - Full screen if it is a storage port; otherwise, a reserved field for a
channel port.
0x08
Terminal - Line mode if it is a storage port; otherwise, an emulated control unit
support only.
0x09
Reserved.
0x10
Switch, if it is a switch device; otherwise, reserved.
0x0b-0xff
Reserved.
Byte CC
Possible values include the following:
0x00
If storage CU port has registered with the switch.
Fabric OS Command Reference
53-1003108-01
377
2
ficonShow
0xID
CHIPID if channel port has registered with the switch.
0xPN
If switch has registered with the channel, PN represents the FL port number.
Part Number
Displays the switch chassis part number.
PID
Displays the 24-bit Fibre Channel port address in 0xDDAAPP format. DD is
Domain ID. AA is Area ID. PP is AL_PA ID.
Plant of Manufacture
Displays the manufacturer plant name or code.
Port
Physical port number.
Port Status
Displays the status of the port as one of the following:
•
•
Link degraded but operational
Link not operational
Port Type
Displays the port type as one of the following:
U
Unknown
N
N_Port
NL
NL_Port
Protocol
Displays whether the traffic is using FICON or FCP.
Registered Node WWN
Displays the device's node world wide name associated with the device HBA.
Registered Port WWN
Displays the device's channel or storage CU port world wide name associated
with the device HBA.
Sequence Number
Displays the sequence number of the self-describing node.
Serial Number
Displays the switch serial number.
Switch node WWN
Displays the switch node world wide name.
Switch Port WWN
Displays the switch port world wide name.
Switch WWN
Displays the switch WWN.
Tag
Displays the physical identifier for the self-describing node interface.
TS Format
Displays the Time Server format.
378
Fabric OS Command Reference
53-1003108-01
ficonShow
2
Time Stamp
Displays the timestamp, expressed in date format.
Type
Same as Port Type.
Type Number
Displays the type number of the self-describing node. It also describes the
machine type.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
database
Specify the database to display. This operand is required. Valid values include the
following
RNID
Device node identification.
LIRR
Devices registered to receive link incident reports. Entries can have the following
flags:
-C*
A user-configured LIRR entry defined as current (set with the ficonCfg
command).
-C
A LIRR entry defined by the management server demon as current based on
order.
-S
A LIRR entry defined by the management server demon as secondary.
SwitchRNID
Switch node identification.
RLIR
Link incident reports.
ILIR
Implicit link incident reports.
fabric
Displays FICON database information for the entire fabric. This operand is
optional; if omitted, only local members of the named database are displayed.
table
Displays RNID data in table format.
port
Displays RNID data for the specified port.
port_index
Specifies the port index number in decimal or the area field (middle byte) of the
Fibre Channel Address (PID) in hexadecimal format.
Fabric OS Command Reference
53-1003108-01
379
2
ficonShow
EXAMPLES
To display the local RNID database:
switch:admin> ficonshow RNID
{
{Fmt Type PID Registered Port WWN
Registered Node WWN \
0x18 N 502b00 50:05:07:64:01:00:15:8d 50:05:07:64:00:c1:69:ca \
flag Parm
0x10 0x200110
Type number:
002064
Model number:
101
Manufacturer:
IBM
Plant of Manufacture: 02
Sequence Number:
0000000169CA
tag:
102b
}
{Fmt Type PID Registered Port WWN
Registered Node WWN \
0x18 N 502e00 50:05:07:64:01:40:0f:ca 50:05:07:64:00:c1:69:ca \
flag Parm
0x10 0x200105
Type number:
002064
Model number:
101
Manufacturer:
IBM
Plant of Manufacture: 02
Sequence Number:
0000000169CA
tag:
052e
}
}
To display the local RNID database in tabular format:
switch:admin> ficonshow RNID table
{
Fmt Type PID
Registered Port WWN
Registered Node WWN
0x18 N
252500 50:05:07:60:28:bf:42:cf 50:05:07:64:00:cd:01:b6
0x18 N
255800 50:05:07:60:28:bf:3e:98 50:05:07:64:00:cd:01:b6
0x18 N
255A00 50:05:07:60:28:bf:2c:9e 50:05:07:64:00:cd:01:b6
0x18 N
255B00 50:05:07:60:28:bf:3f:0b 50:05:07:64:00:cd:01:b6
0x18 N
255C00 50:05:07:60:28:bf:3f:0a 50:05:07:64:00:cd:01:b6
0x18 N
255D00 50:05:07:60:28:bf:2c:9f 50:05:07:64:00:cd:01:b6
0x18 N
255E00 50:05:07:60:28:bf:18:63 50:05:07:64:00:cd:01:b6
0x18 N
255F00 50:05:07:60:28:bf:18:64 50:05:07:64:00:cd:01:b6
0x18 E
258600 20:86:00:05:33:0d:b7:05 10:00:00:05:33:0d:b7:05
0x18 E
258700 20:87:00:05:33:0d:b7:05 10:00:00:05:33:0d:b7:05
0x18 E
25F600 20:f6:00:05:33:0d:b7:05 10:00:00:05:33:0d:b7:05
flag Parm
Type
Mod Manf Plant Sequence#
Tag
0x10 0x3101DB 002817 M15 IBM 02
0000000D01B6 40DB
0x10 0x310138 002817 M15 IBM 02
0000000D01B6 4038
0x10 0x3101D4 002817 M15 IBM 02
0000000D01B6 40D4
0x10 0x3101D7 002817 M15 IBM 02
0000000D01B6 40D7
0x10 0x3101D6 002817 M15 IBM 02
0000000D01B6 40D6
0x10 0x3101D5 002817 M15 IBM 02
0000000D01B6 40D5
0x10 0x3101D8 002817 M15 IBM 02
0000000D01B6 40D8
0x10 0x3101D9 002817 M15 IBM 02
0000000D01B6 40D9
0x00 0x200A00 SLKWRM DCX BRD CA
5FT00X39C19A 22FF
0x00 0x200A00 SLKWRM DCX BRD CA
5FT00X39C19A 22FF
0x00 0x200A00 SLKWRM DCX BRD CA
5FT00X39C19A 22FF
}
11 valid entries, 0 not current entries
The Local RNID database has 11 entries.
380
Fabric OS Command Reference
53-1003108-01
ficonShow
2
To display RNID data for the specified port:
switch:admin> ficonshow RNID port 0x08
{Fmt Type PID
Registered Port WWN
Registered Node WWN \
0x18 E
010800 20:08:00:05:1e:57:b1:86 10:00:00:05:1e:57:b1:86\
flag Parm
0x00 0x200a00
Type number:
BROCAD
Model number:
510
Manufacturer:
BRD
Plant of Manufacture: CA
Sequence Number:
0ALM0632D038
tag:
03ff
}
To display the local LIRR database:
switch:admin> ficonshow LIRR
{Fmt Type PID
Listener Port WWN
0x18 N
255800 50:05:07:60:28:bf:3e:98
0x18 N
255a00 50:05:07:60:28:bf:2c:9e
0x18 N
255b00 50:05:07:60:28:bf:3f:0b
0x18 N
255c00 50:05:07:60:28:bf:3f:0a
0x18 N
255d00 50:05:07:60:28:bf:2c:9f
0x18 N
255e00 50:05:07:60:28:bf:18:63
0x18 N
255f00 50:05:07:60:28:bf:18:64
Switch Port WWN
20:58:00:05:33:0d:b7:05
20:5a:00:05:33:0d:b7:05
20:5b:00:05:33:0d:b7:05
20:5c:00:05:33:0d:b7:05
20:5d:00:05:33:0d:b7:05
20:5e:00:05:33:0d:b7:05
20:5f:00:05:33:0d:b7:05
}
The Local LIRR database
\
\
\
\
\
\
\
Listener Type
Conditional-S
Conditional
Conditional
Conditional
Conditional
Conditional
Conditional-C*
has 7 entries.
Current LIRR device port number: 95 (0x5f)
To display the local and remote LIRR database:
switch:admin> ficonshow LIRR fabric
{Fmt Type PID
Listener Port WWN
0x18 N
502d00 50:05:07:64:01:40:11:79
0x18 N
510d00 50:05:07:64:01:00:15:8c
0x18 N
510f00 50:05:07:64:01:00:14:62
\
\
\
\
Switch Port WWN
Listener Type
20:2d:00:60:69:80:1e:4e Conditional-C
20:0d:00:60:69:80:1e:4f Conditional-S
20:0f:00:60:69:80:1e:4f Conditional
}
The LIRR database has 3 entries.
Current LIRR device port number: Not configured
Fabric OS Command Reference
53-1003108-01
381
2
ficonShow
To display the local Switch RNID database:
switch:admin> ficonshow switchrnid
{
{Switch WWN
flag Parm
10:00:00:60:69:80:1e:4e
0x00
0x200a00
Type number:
SLKWRM
Model number:
48K
Manufacturer:
BRD
Plant of Manufacture: CA
Sequence Number:
0RB030000082
tag:
00ff
}
}
The Local switch RNID database has 1 entries.
To display the local RLIR database:
switch:user> ficonshow RLIR
{
{Fmt Type PID Port Incident Count TS Format
Time Stamp
0x18 N 502e00 46
1 Time server Mon Jan 13 04:29:33 2003
Port Status:
Link not operational
Link Failure Type:
Loss of signal or synchronization
Registered Port WWN Registered Node WWN Flag Node Parameters
50:05:07:64:01:40:0f:ca 50:05:07:64:00:c1:69:ca 0x50 0x200105
Type Number:
002064
Model Number:
101
Manufacturer:
IBM
Plant of Manufacture: 02
Sequence Number:
0000000169CA
tag:
2e00
Switch Port WWN
Switch Node WWN
Flag Node Parameters
20:2e:00:60:69:80:1e:4e 10:00:00:60:69:80:1e:4e 0x00 0x200a2e
Switch Part Number:
060-0001501-05
Switch Serial Number: 0FT02X801E4E
Domain:
20480
}
}
The local RLIR database has 1 entry.
SEE ALSO
382
ficonClear
Fabric OS Command Reference
53-1003108-01
fipsCfg
2
fipsCfg
Configures FIPS (Federal Information Processing Standards) mode.
SYNOPSIS
fipscfg --enable [fips | selftests | bootprom | dh | sha256]
[-nowarn]
fipscfg --disable [selftests | bootprom | dh | sha256]
[-nowarn]
fipscfg --zeroize [-nowarn]
fipscfg --show | --showall
fipscfg --force fips
fipscfg --verify fips
DESCRIPTION
Use this command to configure FIPS mode on the switch. In this mode, only FIPS-compliant algorithms
are allowed. As part of FIPS 140-2 level-2 compliance, passwords, shared secrets and the private keys
used in SSL/TLS, system login, etc., need to be zeroized. Power-up self tests are executed when the
switch is powered on to check for the consistency of the algorithms implemented on the switch.
This command prompts for confirmation before FIPS configuration changes take effect. Specifying no
cancels the operation. The -nowarn option overrides the prompting.
NOTES
Certain services and functions, such as FTP, HTTP, remote procedure calls (RPC), root account, boot
prom access, etc., must be blocked before the system can enter FIPS mode.
LDAP should not be configured while FIPS is enabled.
The system must be rebooted for FIPS mode changes to take effect.
Refer to the Fabric OS Administrator's Guide for information on configuring your system for FIPS 140-2
level-2 compliance.
FIPS mode cannot be modified through configDownload.
FIPS is not supported on all platforms. For FIPS-compliant hardware, refer to the Fabric OS
Administrator's Guide.
In a Virtual Fabric environment, FIPS is treated as chassis-wide configuration and applies to all logical
switches in the chassis. Chassis permissions are required to configure FIPS.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--help
Prints command usage.
--disable selftests [-nowarn]
Disables selftests mode.
--enable [fips | selftests] [-nowarn]
Enables FIPS or selftests mode. Selftests must be enabled before FIPS mode is
enabled.
Fabric OS Command Reference
53-1003108-01
383
2
fipsCfg
--zeroize [-nowarn]
Erases all passwords, shared secrets, private keys, etc. in the system.
--show | --showall
Displays the current FIPS configuration.
--force fips
This option enables FIPS mode even if prerequisites are not met, except under
the following two conditions:
•
•
In a dual-CP system if HA is not in sync between the two CPs.
If selftests is in a disabled state.
--verify fips
Scans the prerequisites for enabling FIPS and print the failure/success cases.
--disable | --enable bootprom [-nowarn]
Disables or enables the Boot Programmable Read-Only Memory (Boot PROM) on
the switch. Boot PROM access is blocked in FIPS mode. Disabling Boot PROM
requires root permission. Enabling Boot PROM does not require root permission.
--disable | --enable dh [-nowarn]
Removes or configures all the Diffie hellman specific SSH configurations on both
the SSH server and client configuration, and restarts the SSH server. This
command is supported only in FIPS mode
--disable | --enable sha256 [-nowarn]
Configures the hash as SHA1 (for disable command) or SHA256 for signature
generation and verification in both the SSH server and client configuration, and
restarts the SSH server. This command is supported only in FIPS mode
EXAMPLES
To display the current FIPS configuration:
switch:admin> fipscfg --show
FIPS mode is :
Disabled
FIPS Selftests mode/status is :
Disabled/None
To enable selftests:
switch admin> fipscfg --enable selftests
You are enabling selftests.
Do you want to continue? (yes, y, no, n) [no] : yes
FIPS Selftests mode/status has been set to :
Enabled/None
To verify FIPS prerequisites:
switch:admin> fipscfg --verify fips
Standby firmware supports FIPS - PASS
SELF tests check has passed - PASS
Root account is enabled - FAIL
Radius check has passed - PASS
Authentication check has passed - PASS
Inflight Encryption check has passed - PASS
IPSec check has passed - PASS
Telnet port number <23> for the policy <default_ipv4> is in permit state.
HTTP port number <80> for the policy <default_ipv4> is in permit state.
RPC port number <897> for the policy <default_ipv4> is in permit state.
IPv4 policies not FIPS compliant - FAIL
NEWLY Added message
Telnet port number <23> for the policy <default_ipv6> is in permit state.
HTTP port number <80> for the policy <default_ipv6> is in permit state.
RPC port number <897> for the policy <default_ipv6> is in permit state.
IPv6 policies not FIPS compliant - FAIL è NEWLY Added message
SNMP is not in read only mode - FAIL
384
Fabric OS Command Reference
53-1003108-01
fipsCfg
2
Bootprom access is enabled - FAIL
Firmwaredownload signature verification is disabled - FAIL
Secure config upload/download is disabled - FAIL
SSH DSA Keys check passed - PASS
Inband Management interface is disabled - PASS
Ipsecconfig is disabled. – PASS
Signature Algorithm used in LDAP CA certificate is not Sha256
Signature Algorithm used in Switch CA certificate is not Sha256
Signature Algorithm used in HTTPS certificate is not Sha256
Signature Algorithm used in FCAP certificate is not Sha256
Signature Algorithm used in FCAP CA certificate is not Sha256
Certificates are not FIPS compliant - FAIL
Certificates validation has passed - PASS
SSH client's ShaValue is not configured as 2 - FAIL
SSH client's MinPrime is not configured as 2048 - FAIL
SSH client's KexAlgorithms is not configured as
diffie-hellman-group-exchange-sha256 - FAIL
SSH client's ServerHostKeySize is not configured as 2048 - FAIL
SSH server's ShaValue is not configured as 2 - FAIL
SSH config is not FIPS compliant - FAIL
To enable FIPS after prerequisites have been met:
switch:admin> fipscfg --enable fips
You are enabling FIPS.
Do you want to continue? (yes, y, no, n) [no] : yes
FIPS mode has been set to : Enabled
Please reboot the system
switch:admin> fipscfg --show
FIPS mode is : Enabled
To attempt enabling FIPS when prerequisites are not met:
switch:admin> fipscfg --enable fips
SelfTests mode is not enabled.
Root account is enabled.
Authentication uses MD5 hash algorithm.
Authentication uses DH group 0.
Telnet port number <23> for the policy <default_ipv4> \
is in permit state.
HTTP port number <80> for the policy <default_ipv4> \
is in permit state.
RPC port number <898> for the policy <default_ipv4> \
is in permit state.
Telnet port number <23> for the policy <default_ipv6>\
is in permit state.
HTTP port number <80> for the policy <default_ipv6> \
is in permit state.
RPC port number <898> for the policy <default_ipv6> \
is in permit state.
SNMP is not in read only mode.
Bootprom access is enabled.
FIPS mode cannot be configured at this time
Fabric OS Command Reference
53-1003108-01
385
2
fipsCfg
To back out of a zeroizing operation:
switch:admin> fipscfg --zeroize
You are Zeroizing FIPS configuration.
Do you want to continue? (yes, y, no, n) [no]: no
Operation cancelled.
switch:admin> fipscfg --zeroize
You are Zeroizing FIPS configuration.
Do you want to continue? (yes, y, no, n) [no]: yes
Executing 'secauthsecret
--remove --all':
This command deletes database of DH-CHAP secret keys.\
If a fabric requires authentication, deleting this \
database may cause switch to segment from the fabric.
Do want to remove secret key database? \
(yes, y, no, n): [no]
Operation cancelled...
Executing 'pkiremove':
WARNING!!!
Removing pki objects will impair the security functionality
of this fibre channel switch. If you want secure mode enabled,
you will need to get the switch certificate again.
About to remove Pki objects.
ARE YOU SURE (yes, y, no, n): [no]
Operation cancelled.
Executing 'passwddefault':
Password policies are already set to default.
Executing 'seccertutil delkey':
Deleting the key pair will automatically do the following:
1.
2.
3.
4.
Delete all existing CSRs.
Delete all existing certificates.
Reset the certificate filename to none.
Disable secure protocols.
Continue (yes, y, no, n): [no]
Operation cancelled.
Zeroizing Radius configuration:
RADIUS configuration does not exist.
LDAP configuration does not exist.
Zeroizing IPSec static SA configuration.
Zeroizing SSH key.
Permission denied to perform this operation.
Failed to zeroize SSH public key.
switch:admin>
386
Fabric OS Command Reference
53-1003108-01
fipsCfg
2
To disable bootprom:
switch:root> fipscfg --disable bootprom
You are disabling bootprom.
Do you want to continue? (yes, y, no, n) [no] : no
Operation cancelled.
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
387
2
firmwareCommit
firmwareCommit
Commits switch firmware.
SYNOPSIS
DESCRIPTION
firmwarecommit
Use this command to commit a firmware download to a CP. This command copies an updated firmware
image to the secondary partition and commits both partitions of the CP to an updated version of the
firmware. This must be done after each firmware download and after the switch has been rebooted and a
sanity check is performed to make sure the new image is fine.
For switches that have nonvolatile memory set into two equal partitions, the primary partition is the where
the system boots from; the secondary partition is where a copy of the firmware is stored, in case the
primary partition is damaged.
To maintain the integrity of the firmware image in the nonvolatile memory, the firmwareDownload
command updates the secondary partition only. When firmwareDownload completes successfully and
the CP is rebooted, the system switches the primary partition (with the old firmware) to the secondary,
and the secondary partition (with the new firmware) to the primary.
The default behavior of the firmwareDownload command is to automatically run the firmwareCommit
command after the reboot. If you decide to disable the autocommit option when running
firmwareDownload, you must execute one of the following two commands after the CP is rebooted:
NOTES
•
firmwareCommit copies the primary partition (with new firmware) to the secondary and commits the
new firmware to both partitions of the CP.
•
firmwareRestore copies the secondary partition (with the old firmware) to the primary and backs out
of the new firmware download. The firmwareRestore command can be run only if autocommit was
disabled during the firmware download. Autocommit can be disabled only when you run
firmwareDownload in single mode.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To commit a new version of the firmware:
switch:admin> firmwarecommit
Validating primary partition...
Doing firmwarecommit now.
Please wait ...
Replicating kernel image
...............
FirmwareCommit completes successfully.
SEE ALSO
388
firmwareDownload, firmwareRestore
Fabric OS Command Reference
53-1003108-01
firmwareDownload
2
firmwareDownload
Downloads firmware from a remote host, a local directory, or a USB device.
SYNOPSIS
To invoke the command in interactive mode:
firmwaredownload
To download FOS firmware over a network:
firmwaredownload [ -s [ -b | -n ] ] [ -p ftp | scp | sftp ]
[ -c ] host, user, pfile, passwd
To download SAS/SA firmware over a network (deprecated):
firmwaredownload -a sas | dmm | application
[ -t slot[,slot]... ]
[ -p ftp | scp | sftp ] [ -c ]
host, user, pfile, passwd
To download SAS firmware over a network and remove the existing SA firmware at the same time
(deprecated):
firmwaredownload -a sas [ -t slot[,slot]... ]
[ -p ftp | scp | sftp ] [ -c ] [ -e ]
host, user, pfile, passwd
To download FOS firmware from a USB device:
firmwaredownload [ -s [ -b | -n ] ] [ -U ]
[ -c ] pfile
To download SAS/SA firmware from a USB device (deprecated):
firmwaredownload -a sas | dmm | application
[ -t slot[,slot]... ]
[ -U ] [ -c ] pfile
To download SAS firmware from a USB device and remove the existing SA firmware at the same time
(deprecated):
firmwaredownload -a sas [ -t slot[,slot]... ]
[ -U ] [ -c ] [ -e ] pfile
DESCRIPTION
Use this command to download switch firmware from an FTP or SSH server or local NFS directory to
nonvolatile storage. Switch firmware can also be downloaded from an external USB device on platforms
that support USB.
The new firmware is downloaded as a bundle of packages. Package names are defined in a *.plist file
along with other firmware information (time stamp, platform code, version, etc.). These packages are
made available periodically to add features or to remedy defects. Contact customer support to obtain
information about available firmware versions.
On enterprise-class platforms, this command, by default, downloads the firmware image to both control
processors (CPs) in rollover mode to prevent disruption to application services. This operation depends
on High Availability (HA) support. If HAis not available, use the -s option to upgrade the CPs one at a
time.
Fabric OS Command Reference
53-1003108-01
389
2
firmwareDownload
All systems supported by this firmware have two partitions of nonvolatile storage (primary and
secondary) to store two firmware images. This command always downloads the new image to the
secondary partition and then swaps partitions so the secondary partition becomes the primary.
By default, firmwareDownload reboots the system and activates the new image. Finally, the command
performs a firmwareCommit automatically to copy the new image to the other partition. In systems with
blade processors (BPs), after the new CP firmware is downloaded to the system and activated, the BP
firmware is downloaded to the BP processors if there is a mismatch between the BP and CP firmware.
By default, firmwareDownload performs a full install, autoreboot, and autocommit. These modes are
selectable only in single CP (-s) mode, in which case autoreboot is OFF by default.
For each standalone switch in your fabric, complete all firmware download changes before issuing the
firmwareDownload command on the next switch to ensure a nondisruptive download.
If firmwareDownload is interrupted due to an unexpected reboot as a result of a software error or power
failure, the command automatically recovers the corrupted secondary partition. Wait for the recovery to
complete before starting another firmware download.
NOTES
Firmware download and subsequent POST failure may occur on some platforms, if the firmware commit
operation coincides with the execution of POST. The recommended work around is to disable POST
(diagDisablePost) before you initiate a firmware download and re-enable POST (diagEnablePost) after
the firmware commit operation has completed.
Firmware download procedures may vary depending on which Fabric OS version you are migrating from.
See the Fabric OS Administrator's Guide for restrictions on changing Fabric OS versions.
On certain occasions, you may see messages in the console output of firmwareDownload. These are
internal messages generated by the Linux utilities. You can safely ignore these messages. For relevant
Brocade-generated firmware download messages, refer to the Fabric OS Message Reference(SULB
module).
To correlate Brocade blade names with blade IDs, use the slotShow command.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
The following operands are optional. When invoked without operands, the command goes into interactive
mode.
-U
Downloads the firmware from an attached USB device. This option is valid only on
platforms that support a USB port. Refer to your specific Hardware Reference
Guide for details. The USB device must be enabled prior to firmware download
with the usbStorage command. Firmware must be stored under the default
firmware directory in the USB file system. On a dual-CP chassis, the USB device
must be attached to the active CP. When downloading firmware from a USB
device, the -p option is ignored.
-s
Enables single-CP mode. This mode supports selectively enabling or disabling a
full install, autoreboot, and autocommit on bladed and nonbladed systems. On
enterprise-class platforms, this mode supports upgrading a single CP. When
downloading the main Fabric OS firmware, this option disables autoreboot, unless
overridden by the -b option.
-b
Enables autoreboot mode. When single CP mode is enabled and this operand is
not specified, reboot must be run manually to activate the downloaded image. If
autoreboot mode is enabled, the switch reboots automatically after the firmware
has been downloaded.
390
Fabric OS Command Reference
53-1003108-01
firmwareDownload
2
-n
Disables autocommit mode. When autocommit mode is disabled, the
firmwareCommit command must be executed manually to propagate the
downloaded image to both partitions of the storage device.
host
Specify a valid FTP or SSH server name or IP address. IPV4 and IPv6 addresses
are supported. The firmware is downloaded from the specified host. If a host is not
specified, the firmware is considered accessible on a local directory. To mention
an FTP server by name, a DNS server must first be set up with the dnsConfig
command. If DNS is enabled and a server name is specified, firmwareDownload
automatically determines whether IPv4 or IPv6 should be used.
user
Specify a user name for FTP or SSH server access. This operand can be omitted,
if the firmware is accessible on a local directory, a USB device, or by anonymous
FTP server access. A user name other than "anonymous" is required for SSH
server access.
pfile
Specify a fully qualified path for the firmware pfile. Absolute path names may be
specified using forward slashes (/).
passwd
Specify a password. This operand can be omitted, if the firmware is accessible
through a local directory or an attached USB device, or if no password is required
by the FTP server. This operand is required when accessing an SSH server. In
Fabric OS v7.0.0 or later, you can omit the password if the switch is configured as
follows:
•
•
•
The switch must be configured with public key authentication. Refer to the
sshUtil help page for more information.
You select a secure protocol (SCP or SFTP).
The private key is installed on the switch, and the public key is exported to the
remote host. Refer to the Fabric OS Administrator's Guide for configuration
procedures.
-p scp | ftp | sftp
Specify the file transfer protocol. Valid values are ftp (file transfer protocol), sftp
(secure file transfer protocol), and scp (secure copy protocol). Values are not
case-sensitive. If -p is not specified, firmwareCommit determines the protocol
automatically by checking the config.security parameter.
-a fos | sas | application
Specify the type of firmware to be downloaded. Accepted values are fos, sas, or
any valid application name. Values are not case-sensitive. This operand is no
longer supported as of Fabric OS v7.0.0.
-t slot[,slot]...
Specify the target slots for the firmware download. Valid values are a list of slot
numbers separated by commas.
-c
Disables version compatibility checking. By default, firmwareDownload checks if
the firmware being downloaded is compatible with other running firmware images
in the system. If the firmware version is not compatible, firmwareDownload fails.
If this option is specified, version compatibility checking is disabled.
Fabric OS Command Reference
53-1003108-01
391
2
firmwareDownload
-e
Removes all of the installed SA images in the system during SAS firmware
download. By default, downloading a SAS image does not remove the installed
SA images. If this option is specified, the installed SA images are removed. This
option is only valid with the -a sas option. This operand is no longer supported as
of Fabric OS v7.0.0.
-o
Bypasses the checking of Coordinated HotCode Load (HCL). On single CP
systems in InterOp fabrics, the HCL protocol is used to ensure data traffic is
notdisrupted during firmware upgrades. This option allows firmwareDownload to
continue even if HCL is not supported in the fabric or the protocol fails. Using this
option may cause traffic disruption for some switches in the fabric.This operand is
no longer supported as of Fabric OS v7.0.0.
DIAGNOSTICS
The command checks the network connection and other system parameters before initiating
firmwareDownload. It may fail if at least one of the following conditions is encountered:
•
•
•
•
•
•
•
The host is not reachable from the switch.
•
The USB device is not enabled. Use the usbStorage command on the switch to enable the USB
device. On enterprise-class platforms, the command must be run on the Active CP to enable the
USB device.
The user does not have permission on the host.
The password is not specified correctly.
Indicated firmware does not exist on the host, or is not in the right format, or is corrupted.
The FTP or SSH service is not running on the host.
The platform is not supported by the firmware indicated.
The USB device may not be plugged in correctly. On standalone switches, the device must be
plugged into the switch USB port. On enterprise-class platforms, the USB device must be plugged
into the Active CP
For additional system messages, refer to the Fabric OS Message Reference.
EXAMPLES
To download the firmware to both CPs on a dual-CP chassis with an attached USB device (You would
execute the same command on a single-CP switch with USB support. Output may vary depending on
platform.):
switch:admin> firmwaredownload -U v7.0.0
Checking system settings for firmwaredownload...
Protocol selected: USB
Trying address-->AF_INET IP: 127.1.1.8, flags : 2
System settings check passed.
Checking version compatibility...
Version compatibility check passed.
This command will upgrade the firmware on both
CP blades. If you want to upgrade firmware on a single
CP only, please use -s option.
You may run firmwaredownloadstatus to get the status
of this command.
This command will cause a warm/non-disruptive boot on
the active CP, but will require that existing telnet,
secure telnet or SSH sessions be restarted.
392
Fabric OS Command Reference
53-1003108-01
firmwareDownload
2
To download firmware interactively:
switch:admin> firmwaredownload
Server Name or IP Address: 192.168.32.10
User Name: admin
File Name: ~admin/dist/FOS7.0.0/
Network Protocol(1-auto-select, 2-FTP, 3-SCP, 4-SFTP) [1]:
Password:********
To download firmware without a password using public key authentication:
switch:admin> firmwaredownload
Server Name or IP Address: 10.38.17.17
User Name: admin
File Name: /users/home25/admin/dist
Network Protocol(1-auto-select, 2-FTP, 3-SCP, 4-SFTP) [1]: 3
Verifying if the public key authentication is available.
Please wait ...Success.
Do Auto-Commit after Reboot [Y]: y
Reboot system after download [N]: y
Server IP: 10.38.17.17, Protocol IPv4
Checking system settings for firmwaredownload...
System settings check passed.
(Output truncated)
SEE ALSO
firmwareCommit, firmwareDownloadStatus, firmwareKeyShow, firmwareRestore, firmwareShow,
reboot, slotShow, version
Fabric OS Command Reference
53-1003108-01
393
2
firmwareDownloadStatus
firmwareDownloadStatus
Displays the status of a firmware download.
SYNOPSIS
firmwaredownloadstatus
DESCRIPTION
Use this command to display an event log that records the progress and status of events during a
firmware download. The event log is created by the firmware download process and is kept until you
issue another firmwareDownload command. A timestamp is associated with each event. When
downloading Fabric OS firmware, the event logs in the two control processors (CPs) are synchronized
and you can run this command from either CP.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the status of a firmware download on a switch:
switch:admin> firmwaredownloadstatus
[1]: Tue Mar 29 21:43:14 2011
Firmware is being downloaded to the switch. This step may take up to 30
minutes.
[2]: Tue Mar 29 21:48:26 2011
Firmware has been downloaded to the secondary partition of the switch.
[3]: Tue Mar 29 22:06:57 2011
The firmware commit operation has started. This may take up to 10 minutes.
[4]: Tue Mar 29 22:10:19 2011
The commit operation has completed successfully.
[5]: Tue Mar 29 22:10:19 2011
Firmwaredownload command has completed successfully. Use firmwareshow to
verify the firmware versions.
To display the status of a firmware download on a chassis:
switch:admin> firmwaredownloadstatus
[1]: Fri Mar 25 13:12:56 2011
Slot 7 (CP1, active): Firmware is being downloaded to the switch. This step
may take up to 30 minutes.
[2]: Fri Mar 25 13:33:23 2011
Slot 7 (CP1, active): Firmware has been downloaded to the secondary partition
of the switch.
[3]: Fri Mar 25 16:38:55 2011
Slot 7 (CP1, active): Firmwarerestore is entered. System will reboot and a
firmware commit operation will start upon boot up.
[4]: Fri Mar 25 16:49:12 2011
Slot 7 (CP1, standby): The firmware commit operation has started. This may
take up to 10 minutes.
394
Fabric OS Command Reference
53-1003108-01
firmwareDownloadStatus
2
[5]: Fri Mar 25 16:58:44 2011
Slot 7 (CP1, standby): Firmware commit operation has started to restore the
secondary partition.
[6]: Fri Mar 25 16:58:45 2011
Slot 7 (CP1, standby): The firmware commit operation has started. This may
take up to 10 minutes.
[7]: Fri Mar 25 17:05:34 2011
Slot 7 (CP1, standby): The commit operation has completed successfully.
SEE ALSO
firmwareCommit, firmwareDownload, firmwareRestore, firmwareShow
Fabric OS Command Reference
53-1003108-01
395
2
firmwareKeyShow
firmwareKeyShow
Displays the public key used for signed firmware validation.
SYNOPSIS
firmwarekeyshow
DESCRIPTION
This command displays the contents of the public key used for validating the integrity of firmware images
when signed firmware validation is enabled.
NOTES
A firmware key should be installed on every switch as a part of the Fabric OS installation. The presence
of a firmware key does not imply that the firmware signature is checked during firmwareDownload.
Signed Firmware Download must be enabled before the public key can be used for signature validation.
Use the configure command to enable Signed Firmware Download.
If Signed Firmware Download is enabled, and if the validation succeeds, firmware download proceeds
normally. If the firmware is not signed or if the signature validation fails, signed firmware download fails.
Refer to the Fabric OS Administrator's Guide for complete details on upgrading or downgrading firmware.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the public key used for signed firmware validation:
switch:admin> firmwarekeyshow
-----BEGIN PUBLIC KEY----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjuQpMk4FrceFvVZ12iAakFNv9
k4ZGhFDMPGIHIems1Ywqdl55U7LTDIVwoViTLevtIDn012r1XlNQ+DORAzvJfkwD
XegkeTn/8wDgHBwotPz4WTd9UGJ9M0Vs52ro1TiukIpsh084LXKgxt+IgdseRCzY
8p8rQZWLpyputx6rgwIDAQAB
-----END PUBLIC KEY-----
SEE ALSO
396
firmwareDownload, configureChassis
Fabric OS Command Reference
53-1003108-01
firmwareRestore
2
firmwareRestore
Restores the former active firmware image.
SYNOPSIS
DESCRIPTION
firmwarerestore
Use this command to restore the former active Fabric OS firmware image. This command can only be
run if autocommit was disabled during the firmwareDownload process.
After a firmwareDownload and a reboot (with autocommit disabled), the downloaded firmware
becomes active. If you do not want to commit the firmware and want to restore the former firmware, issue
the firmwareRestore command. After running firmwareRestore, you can run firmwareDownload
again.
This command reboots the system and makes the former firmware active. After the switch reboots, both
primary and secondary partitions restore the previous firmware.
This command only takes action if the system is booted after a firmwareDownload; otherwise, the
process terminates with an error.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To restore the former active firmware image:
switch:admin> firmwarerestore
Restore old image to be active ...
Restore both primary and secondary image after reboot.
The system is going down for reboot NOW !!
Broadcast message from root (ttyS0) Fri Oct 22 23:48:54 2010...
Doing firmwarecommit now.
Please wait ...
SEE ALSO
firmwareCommit, firmwareDownload
Fabric OS Command Reference
53-1003108-01
397
2
firmwareShow
firmwareShow
Displays the firmware version and download history.
SYNOPSIS
firmwareshow
firmwareshow --history
firmwareshow --help
DESCRIPTION
Use this command to display the firmware versions and the firmware download history. The command
shows the firmware versions on both the primary and secondary partitions of the storage device. When
this command is issued while a firmware download is in process, an appropriate warning message is
displayed.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--history
Displays the contents of the firmware download log. For each firmware download
record, the command displays the date and time, the switch name, the slot
number, port ID, and firmware version.
--help
Displays the command usage.
EXAMPLES
To display the firmware versions on a Brocade DCX 8510-8 while a firmware download is in progress:
switch:admin> firmwareshow
Slot Name Appl Primary/Secondary Versions
Status
---------------------------------------------------6 CP0
FOS
v7.2.0
STANDBY
v7.2.0
7 CP1
FOS
v7.2.0
ACTIVE *
v7.2.0
WARNING: Firmwaredownload is in progress.
To display the firmware version on a standalone switch:
switch:admin> firmwareshow
Appl
Primary/Secondary Versions
-----------------------------------------FOS
v7.2.0
v7.2.0
398
Fabric OS Command Reference
53-1003108-01
firmwareShow
2
To display the firmware download history:
switch:admin> firmwareshow --history
Firmware version history
SEE ALSO
Sno Date & Time
Switch Name Slot PID
1 Fri Feb 18 12:58:06 2011 CDCX16
7 1556
FOS Version
Fabos Version v7.0.0d
2 Wed Feb 16 07:27:38 2011
Fabos Version v7.0.0c
CDCX16
7
1560
firmwareDownload, firmwareDownloadStatus
Fabric OS Command Reference
53-1003108-01
399
2
flow
flow
Creates, manages, and displays flows in Flow Vision.
SYNOPSIS
flow --create flow_name -feature feature_list
port_options frame_options [config_options]
flow --activate flow_name -feature feature_list
flow --deactivate flow_name -feature feature_list
flow --control [flow_name] [-feature feature_list]
[-deviceIdMode mode | -portIdMode mode]
[-simport port_num -enable | -disable]
[-size payload_size | -pattern pattern_string]
[-enable_wrap | -disable_wrap]
flow --reset flow_name -feature feature_list
flow --show [flow_name] [-feature feature_list]
[port_options frame_options]
[-count iterations | -time interval | -verbose]
[-sortby field] [-ctrlcfg]
flow --delete flow_name
flow --help
DESCRIPTION
Use this command to perform the following functions:
•
•
•
•
•
•
Create a flow
Activate or deactivate features for a flow
Clear the data collected for a particular feature of a flow
Change the control parameters for a feature or a flow
Display the flow statistics
Delete a flow
Each of these functions is documented in a separate section that includes function, synopsis, description,
operands, and examples.
A flow is a set of related Fibre Channel (FC) frames or packets that share similar traits, such as an
ingress port, egress port, or frame options that can uniquely differentiate one set of related frames or
packets from a different set of frames. A flow is defined by a combination of ingress port, egress port,
source device, and destination device parameters. Flow Vision supports Flow Monitor, Flow Generator,
and Flow Mirror features to monitor, simulate, and capture the network traffic respectively. You can create
up to 512 flows on Brocade director and 128 flow on switch-based system. For more information on Flow
Vision, refer to the Fabric OS Administrator's Guide.
NOTES
This command requires either a Fabric Vision license or a Fabric Watch and an Advanced Performance
Monitoring licenses.
The Port Mirror or Advanced Performance Monitor with Flow Vision are mutually exclusive.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
400
Fabric OS Command Reference
53-1003108-01
flow
FUNCTION
Creating a flow
SYNOPSIS
flow --create flow_name -feature feature_list
port_options frame_options [config_options]
DESCRIPTION
2
Use this command to create a flow and by default activate the flow for the specified features. This
command validates the flow definition before creating a flow. If the flow definition is not supported by any
specified feature or if the flow definition is a duplicate of an existing active flow, the operation will
terminate with an appropriate error message. For more information on duplicate flows, refer to the Fabric
OS Administrator's Guide.
The following rules apply for creating a flow:
•
•
OPERANDS
You must specify at least one port options (-ingrport or -egrport) but not both.
You must specify the source device (-srcdev), the destination device (-dstdev), or both. The source
device and the destination device can be learned using a wildcard ("*").
•
•
•
The ingress port and egress port must reside in the local switch.
•
•
•
The configuration options -noactivate, -noconfig, and -bidir are optional.
The source device and destination device can reside either in the local or remote switch.
You can create 512 flows on a Brocade director and 128 flows on switch-based system. Note that
each flow discovered when using "*" as a source device or destination device will count as one of
these flows. These system-discovered flows will impact the number of user-defined flows allowed to
be active.
You can create up to 64 monitor flows and four generator flows per port.
You can activate one mirror flow per chassis.
The --create command has the following operands:
flow_name
Specifies the name of the flow. Each flow name must be a unique string
composed of a maximum of 20 alphanumeric or underscore characters. The flow
name is case-insensitive and is always stored as lowercase.
-feature feature_list
Specifies a comma-separated list of features to activate for the flow. Specify "all"
to activate all features for a flow. Valid values for feature_list include the following:
monitor
Activates the Flow Monitor feature for a flow. The Flow Monitor feature monitors
and provides statistics for the specified flow.
The following configuration considerations apply for the Flow Monitor feature:
•
•
•
Fabric OS Command Reference
53-1003108-01
The ingress port and egress port can be an SIM Port, F_Port, E_Port, or
EX_Port (Gen 5 port) on the local switch. The ingress port must be a Gen 5
port and egress port can be a Gen 4 port or Gen 5 port. The SIM Port must be
a Gen 5 port.
VE_Port, VEX_Port, FCoE ports, and GigE are not supported.
The source device and destination device can be a host or target switch, or a
wildcard ("*"). Using the wildcard ("*") enables Flow Vision to learn (discover)
all flows on an F_Port and displays statistics for each learnt flow. The learning
mode is supported only on Gen 5 F_Ports and trunked F_Ports.
401
2
flow
•
•
•
•
You can use WWN or Fibre Channel ID (FCID) for the -srcdev and -dstdev
operands when creating Flow Monitor on EX_Ports. If the Flow Monitor
feature is configured on the ingress port using FCID addressing mode, you
must specify the real SID of the source device and the proxy ID of the
destination device. If the Flow Monitor feature is configured on the egress
port using FCID addressing mode, you must specify the proxy ID of the
source device and real DID of the destination device.
Inter Fabric Link (IFL) flows can be monitored only on EX_Ports in a Fibre
Channel router (FCR).
You can activate the Flow Monitor feature for a maximum of 64 flows per port.
Access Gateway (AG) mode is supported
generator
Activates the Flow Generator feature for a flow. The Flow Generator is a traffic
flow diagnostics feature that generates traffic at line rate in the fabric to validate
connectivity, hardware components, and network performance. You must
configure the ingress or egress ports and the source and destination devices to be
SIM ports before activating a flow using the Flow Generator feature.
You can modify the frame size and payload pattern using the --control options
after creating the flow.
The following configuration considerations apply for the Flow Monitor feature:
•
•
•
•
The Flow Generator feature is not supported on a base switch or ICL port.
AG mode is not supported.
You can activate the Flow Generator feature on four flows per port.
The -frametype, -lun, and -bidir options are not supported with the Flow
Generator feature.
mirror
Activates the Flow Mirror feature for a flow. The Flow Mirror captures network
traffic in a flow and sends it to the switch CPU for traffic analysis. This feature
mirrors only the flows that are in active state. The logging mechanism of the
frames can be modified by using the --control -enable_wrap | -disable_wrap
options.
For both switch-based system and a chassis-based system, a maximum of 256
frames per second are mirrored. A maximum of 1280 frames are stored for
switch-based systems and 5120 frames are stored for chassis-based systems.
The following configuration considerations apply for the Flow Mirror feature:
•
•
•
•
•
The ingress port or the egress port must be an F_Port, which is 8G or less, on
the local switch.
The Flow Mirror feature is supported only on Gen 5 ports.
EX_Ports, XISL ports, DISL ports, E_Ports, trunked E_Ports, and trunked
F_Ports are not supported.
AG mode is not supported.
The Flow Mirror feature can be active on only one flow per chassis.
port_options
Specifies the options to configure the ingress or egress ports.
-ingrport port
Specifies the ingress port. The port can be in either [slot/]port or D,I (Domain,
Index) format depending on the port mode configured using the -portIdMode
operand.
402
Fabric OS Command Reference
53-1003108-01
flow
2
-egrport port
Specifies the egress port. The port can be in either [slot/]port or D,I format
depending on the port mode configured using the -portIdMode operand.
The -ingrport and -egrport options are mutually exclusive; that is, you can
specify only one of the options. The learning mode ("*") is not supported.
frame_options
Specifies the options that represent the content of the FC frame or attributes of the
frame.
-srcdev device_id
Specifies the 3-byte source ID of the originator device. The device_id can be in
PID or PWWN format depending on the device ID mode configured using the
-deviceIdMode operand. The PID format is 0xDDAAPP, where DD is the Domain
ID, AA is the Area ID and PP is the AL_PA ID. The PWWN format is
"XX:XX:XX:XX:XX:XX:XX:XX". Specify "*" to enumerate all originator devices.
-dstdev device_id
Specifies the 3-byte destination ID of the destination device. The device_id can be
in PID or PWWN format depending on the device ID mode configured using the
-deviceIdMode operand. The PID format is 0xDDAAPP, where DD is the Domain
ID, AA is the Area ID and PP is the AL_PA ID. The PWWN format is
"XX:XX:XX:XX:XX:XX:XX:XX". Specify "*" to enumerate all destination devices.
-lun LUN_id
Specifies the LUN identification in decimal or hexadecimal (2-byte value) format.
The valid range for LUN_id is from 0 through 65535 (0x0000 to 0xFFFF). The
LUN parameter includes the addressing method and fields associated with the
respective addressing method. If the most significant byte (MSB) is not specified
in the flow definition, 0x00 is used. This operand is not supported by the Flow
Generator feature.
-frametype type
Specifies the predefined frame type. Valid values for type include the following:
SCSI, SCSIRead, SCSIWrite, SCSIRW, SCSI2Reserve, SCSI3Reserve,
scsicmdsts, ABTS, BAACC, SCSI2Release, SCSI3Release, SCSITur,
SCSI2ReserveRelease, SCSI3ReserveRelease, SCSIGoodStatus,
SCSICheckStatus, SCSIResvConflict, SCSIInquiry, SCSIXferrdy, and BARJT.
This operand is not supported by the Flow Generator feature.
config_options
Specifies the flow configuration options.
-bidir
Configures the features to act on both incoming and outgoing directions on
bidirectional traffic. For example, the Flow Mirror feature mirrors the frames on
both directions: traffic originating from the source device and traffic that is
destined to the source device. This operand is not supported by the Flow
Generator feature.
-noactivate
Allows a flow to be created, but suppresses activation of a flow.
-noconfig
Overrides the default behavior, which automatically saves the flow in the
persistent configuration when you create a flow. The flow will be lost when the
system is rebooted.
Fabric OS Command Reference
53-1003108-01
403
2
flow
EXAMPLES
To create a flow on ingress port (1/10) for traffic from the source device (0x020a00) to the destination
device (0x030000) and activate the flow for the Flow Mirror and Flow Monitor features:
switch:admin> flow --create myflow1 -feature mirror,monitor
-ingrport 1/10 -srcdev 0x020a00 -dstdev 0x030000
To create a flow to monitor SCSI frames going through an egress port:
switch:admin> flow --create scsicsflow -feature monitor
-egrport 1/9 -frametype scsicheckstatus
To create a flow to monitor statistics from a particular source to destination on a specified LUN:
switch:admin> flow --create lunflow -feature monitor
-srcdev 0x010502 -dstdev 0x030700 -ingrport 1/5 -lun 4
To create a flow from source device (0x010203) to destination device(0x020304) for Flow Generator
feature without saving the flow:
switch:admin> flow --create myflow2 -feature generator
-srcdev 0x010203 -dstdev 0x020304 -ingrport 2/3 -noconfig
To create a flow from source device (0x01ba00) to destination device(0x01c000) for Flow Generator
feature without activating the flow:
switch:admin> flow --create myflow3 -feature generator
-srcdev 0x01ba00 -dstdev 0x01c000 -ingrport 2/18 -noactivate
To create a flow to monitor bidirectional traffic from a particular source to destination:
switch:admin> flow --create endtoendflow -feature monitor
-ingrport 2/5 -srcdev 010500 -dstdev 040900 -bidir
To create a flow to monitor traffic from source devices to destination devices in learning mode:
switch:admin> flow --create flowLearn -feature monitor
-ingrport 3/5 -srcdev "*" -dstdev "*"
To create a flow to mirror ingress and egress traffic flowing through a port to an embedded port:
switch:admin> flow --create myflow4 -feature mirror
-ingrport 1/20 -srcdev 0x010203 -lun 0x02 -bidir
To create a flow to generate traffic from the source device (0x020a00) to all destination devices that are
zoned with the source device:
switch:admin> flow --create myflow5 -feature generator
-ingrport 1/10 -srcdev 0x020a00 -dstdev "*"
404
FUNCTION
Activating features or flow
SYNOPSIS
flow --activate flow_name -feature feature_list
Fabric OS Command Reference
53-1003108-01
flow
DESCRIPTION
OPERANDS
2
Use this command to activate a flow if it is not in the active state or configure the specified features for a
flow. Use this command if you created a flow using the -noactivate operand or if none of the features are
activated for the flow. Note that the flows are not enforced until they are active and the flows cannot be
activated without configuring the features. If one or more of the flow parameters are not supported by any
specified feature, the flow will not be activated and the operation will fail with an appropriate error
message.
The --activate command has the following operands:
flow_name
Specifies the name of the flow on which the specified features must be activated.
Specify "all" to activate the specified features for all flows.
feature_list
Specifies a comma-separated list of features to activate for a flow. Specify "all" to
activate all features for a flow. Valid values for feature_list include the following:
monitor, generator, and mirror.
EXAMPLES
To activate Flow Mirror feature for a flow:
switch:admin> flow --activate myflow2 -feature mirror
FUNCTION
Deactivating features
SYNOPSIS
flow --deactivate flow_name -feature feature_list
DESCRIPTION
OPERANDS
Use this command to deactivate the specified features for a flow. All data associated with the deactivated
feature will be cleared.
The --deactivate command has the following operands:
flow_name
Specifies the name of the flow on which the specified features must be
deactivated. Specify "all" to deactivate the specified features for all flows.
feature_list
Specifies a comma-separated list of features to deactivate for the flow. Specify
"all" to deactivate all features for a flow. Valid values for feature_list include the
following: monitor, generator, and mirror.
EXAMPLES
To deactivate the Flow Mirror feature for a flow:
switch:admin> flow --deactivate myflow2 -feature mirror
FUNCTION
Changing the control parameters
SYNOPSIS
flow --control [flow_name] [-feature feature_list]
[-deviceIdMode mode | -portIdMode mode]
[-simport port_num -enable | -disable]
[-size payload_size | -pattern pattern_string]
[-enable_wrap | -disable_wrap]
Fabric OS Command Reference
53-1003108-01
405
2
flow
DESCRIPTION
OPERANDS
Use this command to modify the port or device addressing mode and to change the control parameters
of a flow or features.
The --control command has the following operands:
flow_name
Specifies the flow name. Specify "all" to modify the control parameters for all
flows. If a flow name is not specified, the default values of the control parameters,
-size and -pattern will be modified; the flows which are already present does not
intake the modified control parameters. The modified control parameters will apply
to all flows created in future.
-feature feature_list
Specifies a comma-separated list of features on which the control parameters
should be applied. Valid values for feature_list include the following: generator
and mirror.
-deviceIdMode mode
Specifies the mode for addressing the devices. The valid values for mode are pid
and wwn. The default mode is pid.
-portIdMode mode
Specifies the mode for addressing the ports. The valid values for mode are
slotport and index. The default mode is slotport.
-simport port
Enables or disables a port as a SIM port. The port can be in [slot/]port or D,I
format depending on the port ID mode configured using the -portIdMode
operand. You can specify a single port or a range of ports in slot/port,
slot/port-port, slot/* (all ports in slot), */* (all ports in switch or logical switch), port,
port-port, and * (all ports in switch or logical switch) formats. The flow name is not
required for enabling or disabling a port as SIM port.
-enable
Enables the port as a SIM port.
-disable
Disables the SIM port configuration on the port.
The following operands are specific to the flow generator feature:
-size payload_size
Specifies the size of the frame payload. The frame size must be specified in
multiples of 4, for example, 64, 68, 120, or 320 characters. The valid range is from
64 through 2048 characters; 0 for random size. The default payload size is 2048
bytes.
-pattern pattern_string
Specifies the ASCII pattern of the payload. The valid range is from 1 through 32
bytes; 0 for random pattern. The default is random pattern.
The following operands are specific to the flow mirror feature. You can use these
operands only if the Flow Mirror feature is not activated for a flow. The flow name
is not required for enabling or disabling this option.
-enable_wrap
Enables the wrapping of mirrored frame logs. This is the default value. The Flow
Mirror flow must be deactivated before using this command. The statistics of the
Flow Mirror flow are reset during this operation.
406
Fabric OS Command Reference
53-1003108-01
flow
2
-disable_wrap
Disables the wrapping of mirrored frame logs. The Flow Mirror flow must be
deactivated before using this command. The statistics of the Flow Mirror flow are
reset during this operation.
EXAMPLES
To change the device addressing mode to WWN:
switch:admin> flow --control -deviceidmode wwn
To change the port addressing mode to index:
switch:admin> flow --control -portidmode index
To configure the ports from 1 to 40 in slot 1 as SIM port:
switch:admin> flow --control -simport 1/1-40 -enable
To remove the SIM port configuration on port 20 in slot 1:
switch:admin> flow --control -simport 1/20 -disable
To modify the size and pattern for a flow:
switch:admin> flow --control myflow2 -feature generator
-size 100 -pattern "1234"
To disable wrapping of frame logs for the Flow Mirror feature:
switch:admin> flow --control -feature mirror -disable_wrap
FUNCTION
Clearing feature data
SYNOPSIS
flow --reset flow_name -feature feature_list
DESCRIPTION
OPERANDS
Use this command to clear the data of the specified flow and feature combination. All the data collected
for the flow and feature combination will be cleared.
The --reset command has the following operands:
flow_name
Specifies the name of the flow on which the feature data must be cleared. Specify
"all" to reset all flows.
feature_list
Specifies a comma-separated list of features. Specify "all" to reset all features for
a flow. Valid values for feature_list include the following: monitor, generator, and
mirror.
EXAMPLES
To clear all the mirrored frames for a flow:
switch:admin> flow --reset myflow1 -feature mirror
FUNCTION
Displaying flow data
SYNOPSIS
flow --show [flow_name] [-feature feature_list]
[port_options frame_options]
[-count iterations | -time interval | -verbose]
[-sortby field] [-ctrlcfg]
Fabric OS Command Reference
53-1003108-01
407
2
flow
DESCRIPTION
Displays the flow definitions and frame statistics. When used without operand, the --show command
displays the list of all flows configured in Flow Vision.
The show on demand feature allows you to display the statistics of the features without creating a flow.
To display the statistics of the features without creating a flow, you must specify the operands without a
flow name and provide a flow definition. The flow will run for a time interval of 6 seconds and the data will
be displayed for the specified features.
OPERANDS
The --show command has the following operands:
flow_name
Displays the parameters and flow statistics for the specified flow. Specify "all" to
display all flows.
-feature feature_list
Displays the statistics for the specified features. Specify "all" to display statistics of
all features.
port_options
Specifies the ingress or egress port options.
-ingrport port
Specifies the ingress port. The port can be in either [slot/]port or D,I (Domain,
Index) format depending on the port mode configured using the -portIdMode
operand.
-egrport port
Specifies the egress port. The port can be in either [slot/]port or D,I format
depending on the port mode configured using the -portIdMode operand.
frame_options
Specifies the options that represent the content of the FC frame or attributes of the
frame.
-srcdev device_id
Specifies the 3-byte source ID of the originator device. The device_id can be in
PID or PWWN format depending on the device ID mode configured using the
-deviceIdMode operand. The PID format is 0xDDAAPP, where DD is the Domain
ID, AA is the Area ID and PP is the AL_PA ID. The PWWN format is
"XX:XX:XX:XX:XX:XX:XX:XX". Specify "*" to enumerate all originator devices.
-dstdev device_id
Specifies the 3-byte destination ID of the destination device. The device_id can be
in PID or PWWN format depending on the device ID mode configured using the
-deviceIdMode operand. The PID format is 0xDDAAPP, where DD is the Domain
ID, AA is the Area ID and PP is the AL_PA ID. The PWWN format is
"XX:XX:XX:XX:XX:XX:XX:XX". Specify "*" to enumerate all destination devices.
-lun LUN_id
Specifies the LUN identification in decimal or hexadecimal (2-byte value) format.
The valid range for LUN_id is from 0 through 65535 (0x0000 to 0xFFFF). The
LUN ID includes the addressing mode. If the most significant byte (MSB) is not
specified, 0x00 is used. This operand is not supported by the Flow Generator
feature.
408
Fabric OS Command Reference
53-1003108-01
flow
2
-frametype type
Specifies the predefined frame type. Valid values for type include the following:
SCSI, SCSIRead, SCSIWrite, SCSIRW, SCSI2Reserve, SCSI3Reserve,
scsicmdsts, ABTS, BAACC, SCSI2Release, SCSI3Release, SCSITur,
SCSI2ReserveRelease, SCSI3ReserveRelease, SCSIGoodStatus,
SCSICheckStatus, SCSIResvConflict, SCSIInquiry, SCSIXferrdy, and BARJT.
This operand is not supported by the Flow Generator feature.
-count value
Specifies the number of times the output must be repeated. The default value is 1
and the maximum value is 10.
-time time_interval
Displays the flow information for the specified time interval until it is terminated
with Ctrl + C. Values are in seconds. The time interval must be specified in
multiples of 5, for example, 5, 10, 15, or 20 seconds.
-verbose
Displays the flow or feature statistics in verbose mode.
-sortby field
Displays the sub-flows for a feature in the specified order. The field can be
columnX, where X is the column number. The value of X can be from 1 to
maximum number of columns present in the --show output. For the Flow Mirror
feature, the sub-flows may or may not be present but the mirrored frames can be
sorted. The -sortby option can be applied if only one feature is specified with the
--show command.
-ctrlcfg
Displays the control parameters.
EXAMPLES
To display all flows in Flow Vision:
switch:admin> flow --show
-------------------------------------------------------------- \
Flow Name | Feature | SrcDev | DstDev |IngrPt|EgrPt \
-------------------------------------------------------------- \
myflow1
|mon+
|020a00
|030000
|1/10 |\
scsicsflow
|mon+
|520a00
|520b00
||1/9
\
lunflow
|mon+
|010502
|030700
|1/5
|\
myflow2
|gen+
|010203
|020304
|2/3
|\
myflow3
|gen
|01ba00
|01c000
|1/18 |\
endtoendflow |mon+
|010500
|040900
|2/5
|\
flowLearn
|mon+
|*
|*
|3/5
|\
myflow4
|mir+
|010203
||1/20 |\
myflow5
|gen+
|020a00
|*
|1/10 |\
-------------------------|BiDir | LUN | FrameType |
-------------------------|no
|||
|no
||sstatc
|
|no
|4
||
|no
|||
|no
|||
|yes
|||
|no
|||
|no
|0x02 ||
|no
|||
+ Denotes feature is currently activated for the flow
Fabric OS Command Reference
53-1003108-01
409
2
flow
To display the flow definition and statistics of a flow:
switch:admin> flow --show myflow2
==========================================================
Name
: myflow2
Features: gen(Activated)
Definition: IngrPort(3),SrcDev(0x010203),DstDev(0x020304)
Flow Generator (Activated):
----------------------| SrcDev | DstDev |
----------------------| 0x010203 | 0x020304 |
----------------------Number of frames generated from IngrPort : 1.50G
==========================================================
To display the statistics of the Flow Monitor feature:
switch:admin> flow --show myflow1 -feature monitor
========================================================================
Name
: myflow1
Features: mon(Activated)
Definition: IngrPort(10),SrcDev(0x020a00),DstDev(0x030000)
Flow Monitor (Activated):
Monitor time: | Tue Jun 25 04:20:06 PDT 2013 |
-------------------------------------------------------------------------------------------------------------------------------|
Frame Count
|
Frames Per Sec.
|
Byte count
|
Tx /
Rx / Total |
Tx /
Rx / Total |
Tx /
Rx / Total
-----------------------------------------------------------------------| 18.20G/
0 / 18.20G|786.52k/
0 /786.52k| 73.48T/
0 / 73.48T
------------------------------------------------------------------------
\
\
\
\
\
\
========================================================================= \
------------------------------------------|
Throughput(Bps)
|Frame Size(Bytes)|
|
Tx /
Rx / Total |
Tx
/
Rx
|
------------------------------------------| 1.56G/
0 / 1.56G|
-/
-|
------------------------------------------============================================
To display the monitor statistics from a particular source to destination on a specified LUN:
switch:admin> flow --show lunflow
=========================================================================
Name : lunflow Features: mon(Activated)
Definition: IngrPort(5),SrcDev(0x010502),DstDev(0x030700),Lun(4)
Flow Monitor:
Monitor time: | Thu Jun 06 15:15:39 UTC 2013 |
-------------------------------------------------------------------------------------------------------------------------------- \
| I/O Count
| I/O Per Sec.(IOPS)
| I/O bytes Transferred \
| Reads / Writes/ Total | Reads / Writes/ Total | Reads / Writes/ Total \
------------------------------------------------------------------------ \
| 44.92k/ 44.94k/ 89.85k| 2.00k/ 2.00k/ 4.01k
| 5.88M/ 5.89M/ 11.77M
\
------------------------------------------------------------------------ \
======================================================================== \
------------------------| I/O bytes Per Sec.
|
410
Fabric OS Command Reference
53-1003108-01
flow
2
| Reads / Writes/ Total |
------------------------| 2.62M/ 2.62M/ 5.25M
|
------------------------=========================
To display the Flow Monitor statistics for bidirectional traffic:
switch:admin> flow --show endtoendflow -feature monitor
========================================================================
Name : endtoendflow Features: mon(Activated)
Definition: IngrPort(1,5),SrcDev(010500),DstDev(040900),BiDir
Flow Monitor:
Monitor time: | Thu Jun 06 15:15:39 UTC 2013 |
------------------------------------------------------------------------------------------------------------------------------ \
| Frame Count
| Frames Per Sec.
| Byte count
\
| Tx / Rx / Total
| Tx / Rx / Total
| Tx / Rx / Total
\
---------------------------------------------------------------------- \
| 2.92M/ 2.96M/ 5.88M | 159.31k/161.78k/321.10k | 5.99G/ 5.99G/ 11.99G \
---------------------------------------------------------------------- \
--------------------------------------------| Throughput(Bps)
|Frame Size(Bytes) |
| Tx / Rx / Total
| Tx / Rx
|
--------------------------------------------| 327.15M/327.28M/654.44M | 2052 / 2020
|
--------------------------------------------------------------------------------------------------------------------|
I/O Count
|
I/O Per Sec.(IOPS) | I/O bytes Transferred
| Reads / Writes/ Total | Reads / Writes/ Total | Reads / Writes/ Total
------------------------------------------------------------------------| 44.92k/ 44.94k/ 89.85k | 2.00k/ 2.00k/ 4.01k
| 5.88G/ 5.89G/ 11.77G
------------------------------------------------------------------------=========================================================================
--------------------------| I/O bytes Per Sec.
|
| Reads / Writes/ Total
|
| 262.84M/262.73M/525.68M |
--------------------------===========================
\
\
\
\
\
\
\
To display the monitor statistics for a flow:
switch:admin> flow --show flowLearn -feature monitor
-------------------------------------------------------------------------| SID(*) | DID(*) | Rx Frames Count | Rx Frames per Sec. | Rx Bytes Count
-------------------------------------------------------------------------| 010500 | 030700 | 2.92M
| 159.31k
| 5.99G
| 010501 | 030700 | 1.92M
| 100.22k
| 4.91G
| 010502 | 030700 | 0.92M
| 51.81k
| 2.36G
| 010500 | 040900 | 2.92M
| 259.31k
| 7.89G
| 010501 | 040900 | 1.92M
| 159.31k
| 3.72G
| 010502 | 040900 | 0.92M
| 159.31k
| 1.08G
-------------------------------------------------------------------------| *
| *
| 12.72M
| 770.37K
| 25.86G
--------------------------------------------------------------------------------------------------------------------| Rx Throughput(Bps) | Avg Rx Frm Sz(Bytes)|
-------------------------------------------| 627.15M
| 2052
|
Fabric OS Command Reference
53-1003108-01
\
\
\
\
\
\
\
\
\
\
\
\
411
2
flow
| 444.62M
| 1052
|
| 314.17M
| 452
|
| 327.15M
| 2052
|
| 327.15M
| 1052
|
| 327.15M
| 452
|
-------------------------------------------| 2.68G
| 1192
|
--------------------------------------------
To display the statistics for the Flow Mirror feature in learning mode:
switch:admin> flow --show mirFlow -feature mirror
Name : mirFlow
Features: mir(Activated)
Definition: EgrPort(17),DstDev(0x051100),BiDir
Flow Mirror:
------------------------------------------------------------ \
| SID(*) | DID(*) | OXID | RXID | SOF
| EOF | Frame_type \
------------------------------------------------------------ \
| 051600 | 051100 | 0883 | ffff | SOFi3 | EOFt | SCSIRead
\
| 051600 | 051100 | 0191 | 0bce | SOFn3 | EOFn | Data
\
| 051600 | 051100 | 0c8f | ffff | SOFi3 | EOFt | SCSIWrite \
| 051600 | 051100 | 0017 | ffff | SOFi3 | EOFt | SCSIWrite \
| 051600 | 051100 | 0191 | 0bce | SOFn3 | EOFn | Data
\
-----------------------| Dir| Time-Stamp
|
-----------------------| Tx | Jun 10 11:08:10 |
| Tx | Jun 10 11:08:10 |
| Tx | Jun 10 11:08:10 |
| Tx | Jun 10 11:08:10 |
| Tx | Jun 10 11:08:10 |
To display the statistics for the Flow Mirror feature in verbose mode:
switch:admin> flow --show mirFlow1 -feature mirror -verbose
Name : mirFlow1
Features: mir(Activated)
Definition: EgrPort(1/5),SrcDev(010200),DstDev(*),BiDir
Flow Mirror:
----------------------------------------------------------------------------Time-Stamp
| Dir | SOF
| EOF | Frame_Type | Frame Contents
|
----------------------------------------------------------------------------Jun 04 08:27:04 | Tx | SOFi3 | EOFt | SCSI3_Res
| 06040500 00010200 08290000
009a0fd3 00000000 00000000 00000000 00000001 5f010300 00000000 18000000
00000000
Jun 04 08:27:04 | Tx | SOFi3 | EOFt | SCSITxRdy
| 05040500 00010200 08890000
07ce01ca 00000000 00000000 00000018 00000000
Jun 04 08:27:04 | Rx | SOFi3 | EOFt | Data
| 01010200 00040500 08090008
089a0f71 00000000 00000000 ffaabbcc 00000000 00000000 00000000 00000000
Jun 04 08:27:04 | Rx | SOFi3 | EOFt | SCSIGoodSts | 07010200 00040500 08990000
089a0f71 00000000 00000000 00000000 00000000 00000000 00000000 00000000
To display the feature statistics in sorted order:
switch:admin> flow --show myflow -feature monitor -sortby column1
Monitor time: | Fri Jun 07 03:56:24 MDT 2013 |
--------------------------------------------------------==================================================================
Name
: myflow Features: gen(Activated), mon(Activated)
Definition: EgrPort(4,8),SrcDev(0x*),DstDev(0x040800)
412
Fabric OS Command Reference
53-1003108-01
flow
Flow Monitor:
---------------------------------------------------------------|SID(*)| Tx Frames Count | Tx Frames per Sec. | Tx Bytes Count
---------------------------------------------------------------| 40600|
11.99M
|
169.68k
|
25.08G
| 40700|
11.99M
|
169.86k
|
25.08G
| 40900|
28.49M
|
403.22k
|
59.38G
-------------------------------------------| Tx Throughput(Bps) | Avg Tx Frm Sz(Bytes)|
-------------------------------------------|
354.97M
|
2088
|
|
355.35M
|
2088
|
|
124.48M
|
2080
|
2
\
\
\
\
\
\
To display the SCSI frame statistics for the Flow Monitor feature:
switch:admin> flow --show scsicsflow -feature monitor
------------------------Frame Statistics
----------------------------------------| Tx Frames Count | Tx Frames per Sec. |
----------------------------------------| 238
| 5
|
-----------------------------------------
To display the control parameters:
switch:admin> flow --show -ctrlcfg
SimPort Information
-----|------|--------|-------------------------|----------------- \
Slot | Port | PID
|
PWWN
| SID Frame Count \
-----|------|--------|-------------------------|----------------- \
1
| 2
| 050200 | 20:02:00:05:1e:e2:8e:00 |
|-----------------| DID Frame Count |
|-----------------|
19.46K
|
0K
\
To display the control parameters for the Flow Generator feature:
switch:admin> flow --show -ctrlcfg -feature generator
Control Parameters of Generator
Size: 1024
Pattern: SCSITur
To display the statistics for the Flow Mirror feature on ingress port (1/10) without creating a flow (show on
demand):
switch:admin> flow --show -srcdev 0x030000 -ingrport 1/10 -feature mirror
FUNCTION
Deleting a flow
SYNOPSIS
flow --delete flow_name
Fabric OS Command Reference
53-1003108-01
413
2
flow
DESCRIPTION
OPERANDS
Use this command to delete the specified flow from Flow Vision. All the data associated with the flow will
be cleared.
The --delete command has the following operands:
flow_name
Specifies the name of the flow to delete. Specify "all" to delete all flows.
EXAMPLES
To delete a flow:
switch:admin> flow --delete myflow1
FUNCTION
Displaying the command help
SYNOPSIS
flow --help [operand] [...]
DESCRIPTION
OPERANDS
Use this command to display the command usage.
operand
Displays the syntax and usage guidelines for the specified operand or sub-option.
EXAMPLES
To display the command usage:
switch:admin> flow --help
Description - Perform Flow Vision operations
SYNTAX: flow <Flow_operations>
<Flow_operations>
--create
<flowname> -feature <list>
<Port options> <Frame options> <Config options>
--delete
<flowname>
--control
[flowname] [-feature <list>]
[-deviceIdMode <mode> | -portIdMode <mode>]
[-simport <portID> -enable/-disable]
[-size <frame size> | -pattern <pattern string>]
[-enable_wrap/-disable_wrap]
--reset
<flowname> -feature <list>
--activate
<flowname> -feature <list>
--deactivate <flowname> -feature <list>
--show
[flowname] [-feature <list>]
[<Port options> <Frame_options>]
[-count <iterations> | -time <interval> | -verbose]
[-sortby <field>] [-ctrlcfg]
To display the command usage for an operand:
switch:admin> flow --help --create
Description - Create a flow definition for Flow Vision features
SYNTAX: flow --create <flowname> -feature <list>
<Port options> <Frame options> <Config options>
<flowname>
-feature <list>
: Unique string of characters to identify a flow
: Comma separated list of Flow Vision features
(mirror, monitor and generator)
<Port options>
-ingrport <portID>: Switch receive port on which feature(s) is applied
-egrport <portID>: Switch transmit port on which feature(s) is applied
414
Fabric OS Command Reference
53-1003108-01
flow
<Frame options>
-srcdev <devID> :
-dstdev <devID> :
-lun <LUN ID>
:
-frametype <ftyp>:
<Config options>
-bidir
-noactivate
-noconfig
2
FC device that is flow source (SID or PWWN)
FC device that is flow destination (DID or PWWN)
SCSI LUN identifier
Frame type applicable to the flow
: Applies Flow Vision features for both directions of flow
: Creates flow without activating the flow
: Creates flow without saving persistently
To display the command usage for an operand and sub-option:
switch:admin> flow --help --create -frametype
-frametype <ftyp>: FC frame types applicable to the flow.
<ftyp> can be one of scsi, srd, swr, srdwr, sres2, sres3,
scsirel2, stur, scsiresrel2, scsigoodstatus,
scsicheckstatus, scsirel3, scsiresrel3, srescnfl, sinq,
sxfr, scmdsts, abts, bacc, barjt.
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
415
2
fmMonitor
fmMonitor
Manages frame monitor configuration.
SYNOPSIS
fmmonitor --create frame_type -pat bit_pattern
[-port port_list] [-highth value]
[-action actions] [-timebase time_base] [-nosave]
fmmonitor --delete frame_type
fmmonitor --show [frame_type] [-port port_list | -all]
[-timeinterval interval]
fmmonitor --change frame_type [-pat bit_pattern]
[-highth value] [-action actions][-timebase time_base]
fmmonitor --addmonitor frame_type -port port_list [-nosave]
fmmonitor --delmonitor frame_type [-port port_list] [-nosave]
fmmonitor --clear frame_type -port port_list
fmmonitor --save frame_type
fmmonitor --help
DESCRIPTION
Use this command to configure, install, and display frame monitors across port ranges on a switch. This
command supports predefined and user-defined names for frame types defined by their offset, bit mask,
and frame values. For each frame type you can configure a threshold and specify one or more alert
mechanisms, such as RAS log, SNMP trap and email.
Frame monitors count the number of frames transmitted through a port that match specific values in the
first 64 bytes of the frame. Because the entire Fibre Channel frame header and many upper protocol (for
example, SCSI) headers fall within the first 64 bytes of a frame, frame monitors can detect different types
of traffic transmitted through a port. Each frame monitor keeps a timestamp of its last refresh. It also
keeps a generation count, which is incremented each time the monitor is cleared.
Frame monitors generate alerts whenever the frame count for a certain frame type crosses the threshold
configured for that frame type. You can configure high thresholds for every frame type, specify actions to
be taken when the threshold is exceeded, and configure how often the data are sampled. When you
create a new frame type without specifying the events, a generic filter monitor configuration for
generating events is applied.
The fmMonitor command supports basic Fabric Watch configurations for frame monitors. Use thConfig
with the FILTER class for more advanced configurations.
When you create, add, or delete a monitor, the changes are saved persistently by default. Use the
-nosave option with --create, --addmonitor, and --delmonitor to override the default behavior.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The number of monitors supported per port is platform-specific. Refer to the Fabric OS Administrator's
Guide for more information.
416
Fabric OS Command Reference
53-1003108-01
fmMonitor
2
This command requires an Advanced Performance Monitoring license. A Fabric Watch license is
optional. Without a Fabric Watch license, you cannot use the alert mechanism, but you can still configure
frame monitors and observe the counters.
Frame Monitor types and bit patterns are not case sensitive.
This command is not supported on virtual FC ports (VE/VEX_Port), EX_Port, mirror ports, GbE ports,
and FCoE ports.
OPERANDS
--create
Creates a user-defined frame type to be monitored. A frame type is defined by a
unique name and bit pattern.
--change
Modifies an existing frame type configuration.
frame_type
Specifies a name for the frame type. The name is a user-defined string of up to 10
characters. Strings exceeding the character limit are truncated. The string must be
included in double quotation marks. Spaces are not permitted. This operand is
required with all configuration and display options.
Use the --change option to modify an existing frame type that you created earlier
by changing, for example, the bit pattern, the ports where the frames should be
monitored, or the alert mechanism. You can also use the --change option to
modify one of the predefined frame types supported with this command. You can
modify the ports where the frames should be monitored or change the default
threshold and alert mechanism. You cannot change the bit pattern of a predefined
frame type. Frame Types are not case sensitive. They are capitalized here for
readability only.
Predefined frame types include the following :
ABTS
Specifies a frame of type ABTS (Abort Sequence Basic Link Service
command) with a bit pattern of "4,0xFF,0x81;12,0xFF,0x0;"
BA_ACC
Specifies a frame of type BA_ACC (Abort Accept) with a bit pattern of
"4,0xFF, 0x84;12,0xFF,0x00;"
IP
Specifies a frame of type IP with a bit pattern of "12,0xFF,0x05;".
SCSI
Specifies a frame of type SCSI with a bit pattern of "12,0xFF,0x08;".
SCSI_READ
Specifies a frame of type SCSI Read with a bit pattern of
"12,0xFF,0x08;4,0xFF,0x06; 40,0xFF,0x08,0x28;".
SCSI_WRITE
Specifies a frame of type SCSI Write with a bit pattern of
"12,0xFF,0x08;4,0xFF,0x06; 40,0xFF,0x08,0x0A,0x2A;".
SCSI_RW
Specifies a frame of type SCSI Write with a bit pattern of
"12,0xFF,0x08;4,0xFF,0x06; 40,0xFF,0x08,0x28,0x0A,0x2A;".
SCSI2_RESERVE
Specifies a frame of type SCSI-2 Reserve with a bit pattern of
"12,0xFF,0x08;4,0xFF, 0x06;40,0xFF,0x16,0x56;".
Fabric OS Command Reference
53-1003108-01
417
2
fmMonitor
SCSI3_RESERVE
Specifies a frame of type SCSI-3 Reserve with a bit pattern of
"12,0xFF,0x08;4,0xFF,0x06; 40,0xFF,0x5F;41,0xFF,0x01;".
-pat bit_pattern
Specifies a unique combination of values in the first 64 bytes of a frame. The
syntax for the bit patterns is as follows: "offset,bitmask, value;[offset,
bitmask,value;] ...;" for example, "12,0xFF,0x08;4,0xFF,0x06;40,0xFF,0x08,
0x28;". This example monitors for SCSI read command traffic transmitted from a
port by filtering on offset 12 with a value of 0x08 (SCSI-FCP), on offset 4 with
value 0x06 (unsolicited command), and on offset 40 with values of 0x08 or 0x28
(read command). Each pattern must end with a semicolon (;) and the combined
pattern must be enclosed in double quotation marks. This operand is required with
the --create option. It is optional with the --change option.
The pattern components are as follows:
Offset
Specifies the offset within the frame. Offset 0 is the first byte of the
start-of-frame (SOF) delimiter, and offset 4 is the first byte of the frame
header. The offset must be in decimal format. Valid values for offset are 0,
and 4 to 63. Offset 0 is a special case that can be used to monitor the first
four bytes SOFx frames. The end-of--frame (EOF) delimiter cannot be
monitored. A maximum of six offsets can be specified for each filter, and each
offset can match up to four values. The count is incremented by one, if a
frame has a matching value in all the offsets specified by the filter.
bitmask
Specifies the mask value to be applied to frame contents.
value
Specifies the values that need to be captured from the frame contents.
In SOFx frames the offset is specified as 0x0; The value is specified as one of
the following. For example, the value of 0x6 matches frames of type SOFi3:
0
SOFf
1
SOFc1
2
SOFi1
3
SOFn1
4
SOFi2
5
SOFn2
6
SOFi3
7
SOFn3
418
Fabric OS Command Reference
53-1003108-01
fmMonitor
2
-port port_list
Specifies one or more ports on which to install the monitor for the specified frame
type. This operand is optional; if omitted, the monitor is installed on all eligible
ports. A port list can consist of the following:
•
•
One or more single ports, preceded by a slot number followed by a slash (/)
on bladed systems. Multiple ports must be separated by a comma, for
example, 8 or 5/8 or 3,5,8.
One or more port ranges where the beginning and end port are separated by
a dash, for example, 8-13 or 5/8-13, or 3/4-9. A port range cannot span
multiple slots.
-highth value
Sets the high threshold value for the specified frame monitor. This operand is
optional. High threshold values and defaults are platform-specific. Refer to the
Fabric Watch Administrator's Guide for more information.
-timebase time_base
Specifies the time interval between two samples to be compared. Valid intervals
include the following:
day
Samples are compared once a day.
hour
Samples are compared once every hour.
minute
Samples are compared once every minute.
-action value
Specifies the action triggered if the frame count for the specified frame type
exceeds the configured high threshold. Valid actions include snmp, raslog, email
or none. This operand is optional; if omitted, defaults are used (snmp, raslog).
Note that fmMonitor only supports specification of high thresholds and the
actions taken when the frame count exceeds the configured high threshold. Use
the thConfig command with the filter class operand to configure and display other
Fabric Watch thresholds, and the actions to be taken when the counters fall below
or in-between configured Fabric Watch thresholds.
-nosave
Overrides the default behavior, which automatically saves the frame monitor and
port configuration persistently when you create, modify, or delete a monitor. When
you specify -nosave, the port configuration is not saved and will be erased upon
reboot. However, the frame monitor configuration (type, bit pattern, thresholds
etc.) will still be saved persistently. This operand is valid only with the --create,
--addmonitor, and --delmonitor options. The CFG column in the show command
display indicates "not saved" when -nosave is specified; otherwise it indicates
"saved".
--save frame_type
Saves the set of ports on which the specified frame type is monitored to the
persistent configuration. If a frame type is not specified, this command saves the
port configurations of all existing frame types. This operation removes the
configuration for ports not monitored.
--addmonitor frame_type -port port_list
Installs an existing frame monitor on the specified ports.
--delmonitor frame_type -port port_list
Removes an existing frame monitor from the specified ports.
Fabric OS Command Reference
53-1003108-01
419
2
fmMonitor
--delete frame_type
Deletes an existing frame type. This command removes the entire configuration,
including configured threshold and associated actions. It also removes any frame
monitors of the specified type from all ports. This operand is not valid with
predefined frame types.
--clear frame_type -port port_list
Clears the ports on which the specified frame type is monitored from the
persistent configuration.
--show
Displays the specified frame type configuration. When used without operand, the
--show command displays the configured frame types along with their bit
patterns. The following operands are optional:
frame_type
Displays the following information for the specified frame type: Port number,
Frame type, frame count, configured high threshold, configured alerts, time base
and configuration status (saved or N/A). The count field displays one of the
following:
•
•
A decimal number indicates the number of frames of the specified type.
N/A indicates that a frame monitor configuration exists, but it is not assigned
to any specific port.
• A dash ("-") indicates that a frame monitor is not installed on the port, but
there is a configuration for frame monitor on these ports.
This operand is optional; if omitted, this command lists all configured frame types
on the switch along with their bit patterns. The following operands are exclusive.
-port port_list
Specifies the ports for which to display the frame type configurations. Refer to the
description above for valid values.
all
Displays information for all ports and frame types.
-timeinterval interval
Displays the number of frames per second captured by the monitor during the
specified time interval. Values are in seconds. The time interval must be specified
in multiples of 5, for example, 5, 10, 15, or 20 seconds.
--help
Displays the command usage.
EXAMPLES
To create a custom frame type using default thresholds and report actions: The following custom frame
monitor checks all incoming frames at offset 17, applies a mask of 0x0FF to the byte, and looks for a
matching value of 0x07. It also monitors the incoming frames at offset 7, applies a mask of 0x0FF to the
byte, and looks for matching values of 0x4F or 0x01. The counter is incremented when the monitor
detects a frame where byte 17 is 0x07, and byte 7 is 0x4F or 0x01. The thresholds, alerting mechanism ,
action and threshold level for this custom frame type will be imported from a generic filter monitor
configuration.:
switch:admin> fmmonitor --create MyFrameMonitor
-pat "17,0x0FF,0x07;7,0x0FF,0x4F,0x01"
\
To add E-mail alerts to the previously created frame type:
switch:admin> fmmonitor --change MyFrameMonitor
-action email
420
\
Fabric OS Command Reference
53-1003108-01
fmMonitor
2
To install a SCSI frame monitor on ports 3-12:
switch:admin> fmmonitor --addmonitor SCSI -port 3-12
To save the port configuration persistently:
switch:admin> fmmonitor --save SCSI
To delete the custom frame monitor "MyFrameMonitor" from all ports:
switch:admin> fmmonitor --delmonitor MyFrameMonitor
To delete the entire frame type configuration:
switch:admin> fmmonitor --delete MyFrameMonitor
To clear the counters for the SCSI2_READ monitor from ports 7-10:
switch:admin> fmmonitor --clear SCSI2_READ -port 7-10
To display the existing frame types and associated bit patterns on the switch:
switch:admin> fmmonitor --show
FRAME_TYPE BIT PATTERN
---------------------------------------scsi 12,0xFF,0x08;
scsiread 12,0xFF,0x08;4,0xFF,0x06;\
40,0xFF,0x08,0x28;
scsiwrite 12,0xFF,0x08;4,0xFF,0x06;\
40,0xFF,0x08,0x28,0x0A,0x2A;
scsirw 12,0xFF,0x08;4,0xFF,0x06;\
40,0xFF,0x08,0x28,0x0A,0x2A;
scsi2reserve 12,0xFF,0x08;4,0xFF,0x06;\
40,0xFF,0x16,0x56;
scsi3reserve 12,0xFF,0x08;4,0xFF,0x06;\
40,0xFF,0x5F;41,0xFF,0x01
ip 12,0xFF,0x05;
abts 4,0xFF,0x81;12,0xFF,0x0;
baacc 4,0xFF,0x84;12,0xFF,0x00;
To display configuration details for the predefine SCSI frame monitor (Use thConfig filter class to set and
display other Fabric Watch thresholds for frame monitors):
switch:admin> fmmonitor --show scsi
Port|
Frame Type|Count|HIGHThres|Actions |TIMEBASE|CFG
-------------------------------------------------------000002|scsi|0000000000000123|10
|Raslog |None |saved
000003|scsi|0000000000000124|10
|Raslog |None |saved
000004|scsi|0000000000000143|10
|Raslog |None |saved
To display all configured frame types for all ports:
switch:admin> fmmonitor --show all
Port|Frame Type
|HIGH |Actions|TIMEBASE|CFG
|Thres|
-----------------------------------------------------------000062|scsi
|0000000000000123|10 |Raslog |None
|saved
-|scsiread
|N/A
|0
|None
|None
|N/A
-|scsiwrite
|N/A
|0
|None
|None
|N/A
-|scsirw
|N/A
|10 |Raslog |None
|N/A
Fabric OS Command Reference
53-1003108-01
|Count
421
2
fmMonitor
-|scsi2reserve|N/A
|0
-|scsi3reserve|N/A
|0
-|ip
|N/A
|0
-|abts
|N/A
|0
-|baacc
|N/A
|0
000002|beta
|0000000000000145|10
|None
|None
|None
|None
|None
|Email
|None
|None
|None
|None
|None
|None
|N/A
|N/A
|N/A
|N/A
|N/A
|saved
To display the number of frames of type ISCSI_RW per second during a five-second interval:
switch:admin> fmmonitor --show SCSI_RW -port 1/0-47 -timeinterval 5
2011-02-18 15:52:02
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
=========================================================
slot 1: 630 0 0 0 0 0 0 0 0 0 630 0 0 0 0 0
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
=========================================================
slot 1:
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
=========================================================
slot 1: 210 840 210 0 0 0 0 0 0 0 0 0 0 0 0 0
2011-02-18 15:52:07
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
=========================================================
slot 1: 630 0 0 0 0 0 0 0 0 0 630 0 0 0 0 0
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
=========================================================
slot 1:
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
=========================================================
slot 1: 210 840 210 0 0 0 0 0 0 0 0 0 0 0 0 0
(output truncated)
SEE ALSO
422
portThConfig, thConfig
Fabric OS Command Reference
53-1003108-01
fosConfig
2
fosConfig
Displays or modifies Fabric OS features.
SYNOPSIS
fosconfig --enable feature
fosconfig --disable feature
fosconfig --show
DESCRIPTION
Use this command to enable or disable a feature, or to display the current operating status of features on
a switch. This command can be run while the switch is online.
The following features are supported (refer to the Notes for limitations):
•
•
•
•
•
NOTES
FC Routing service (see fcrConfigure)
iSCSI service (not supported in Fabric OS v7.0.0 and later).
iSNS client service (not supported in Fabric OS v7.0.0 and later).
Virtual Fabrics (see lfCfg and lsCfg )
Ethernet switching service
The features described may not be supported on all platforms. If you attempt to enable a feature that is
not supported on your platform, an error message stating "Command not supported on this platform" is
displayed.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--enable feature
Enables a feature on the switch. Valid values for feature include the following:
fcr
Enables the FC Routing service on the switch. The FC Routing service is disabled
by default. Use fosConfig --show to determine if FCR is enabled or disabled,
When enabling FCR, you may encounter one of the following system messages:
"FC Routing service is in the process of being disabled, please try again after a
few minutes." This means that a command to disable the FC Routing service is
still in progress. Wait a few minutes and try again.
"FC Routing service is already enabled." This means that the FC Routing service
is already enabled.
iSCSI
Not supported in Fabric OS v7.0.0 and later.
iSNSC
Not supported in Fabric OS v7.0.0 and later.
vf
Enables Virtual Fabrics. By default, Virtual Fabrics are disabled. Before enabling
the Virtual Fabrics, ensure that there are no Administrative Domains (ADs) in
effect. Administrative Domains must be disabled before enabling Virtual Fabrics.
This command prompts for confirmation, because the chassis reboots after this
command is executed.
Fabric OS Command Reference
53-1003108-01
423
2
fosConfig
ethsw
Enables the Ethernet switch service on the switch. The Ethernet switch service is
disabled by default. Enabling the Ethernet switch service does not disrupt the FC
traffic.
--disable feature
Disables a feature on the switch. Valid values for feature include the following:
fcr
Disables the FC Routing service on the switch. All enabled EX_Ports and
VEX_Ports on the switch must be offline for this command to succeed.
To use this command to disable the FC Routing service only instead of disabling
the switch, issue this command, then change the BB fabric ID using
fcrConfigure.
When disabling the FCR service, you may encounter the following system
messages:
"Please disable all EX/VEX_Ports first before running this command." This means
that there were EX_Ports or VEX_Ports online when this command was issued.
Take these ports offline and try the command again.
"FC Routing service is already disabled" -This means that the FC Routing service
is already disabled.
iSCSI
Not supported in Fabric OS v7.0.0 or later.
iSNSC
Not supported in Fabric OS v7.0.0 or later.
vf
Disables Virtual Fabrics on the switch. This command prompts for confirmation,
because the chassis reboots after this command is executed.
ethsw
Disables the Ethernet switch service. Ethernet switching is disabled by default.
This operation reboots the switch and is therefore disruptive.
--show
Displays the current operating status of features on the switch.
EXAMPLES
To display the operating status of the services on a Brocade 6510:
switch:admin> fosconfig --show
FC Routing service:
iSCSI service:
iSNS client service:
Virtual Fabric:
Ethernet Switch Service:
disabled
Service not supported on this Platform
Service not supported on this Platform
enabled
Service not supported on this Platform
To disable the FC Routing service:
switch:admin> fosconfig --disable fcr
FC Routing service is disabled
To enable the FC Routing service:
switch:admin> fosconfig --enable fcr
FC Routing service is enabled
424
Fabric OS Command Reference
53-1003108-01
fosConfig
2
To enable Virtual Fabrics:
switch:admin> fosconfig --enable vf
WARNING: This is a disruptive operation that \
requires a reboot to take effect.
All EX ports will be disabled upon reboot.
Would you like to continue [Y/N]y
To disable Virtual Fabrics:
switch:admin> fosconfig --disable vf
WARNING: This is a disruptive operation that \
requires a reboot to take effect.
Would you like to continue [Y/N]y
To enable the Ethernet Switching service:
switch:admin> fosconfig --enable ethsw
WARNING: This operation will enable the \
Ethernet Switch Service on this switch.
Would you like to continue [Y/N]: y
Enabling the Ethernet Switch Service. Please wait ...
Create Ethernet switch instance 0
All service instances in sync.
The Ethernet Switch Service has been enabled.
Please enable all of the Blades with ID 74 now.
To disable the Ethernet Switching service:
switch:admin> fosconfig --disable ethsw
WARNING: This is a disruptive operation that \
requires a reboot to take effect.
Would you like to continue [Y/N]: y
The Ethernet Switch Service has been disabled.
Your system is being rebooted now.
The system is coming up, please wait...
SEE ALSO
fcrConfigure, switchShow
Fabric OS Command Reference
53-1003108-01
425
2
fosExec
fosExec
Executes a command in a specified logical switch context.
SYNOPSIS
fosexec --fid FID -cmd "cmd [args]"
fosexec --fid all [-force] -cmd "cmd [args]"
DESCRIPTION
Use this command to execute any Fabric OS command on a specified logical switch context or on all
logical switches. The target logical switch is identified by its fabric ID (FID). When used with the --fid all
option, the specified command is executed in all logical switches.
The FIDs must be part of the FID permission list associated with the user account. If you execute
fosexec --fid all and you do not have permission to one or more of the logical switches (FIDs), the
command prompts for confirmation to continue with the execution of the command in the FIDs for which
you do have permission. You can override the prompt for confirmation with the -force option. Refer to
userConfig help for more information on logical switch access permissions.
Executing chassis-level commands through fosexec --fid all results in redundant output.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
--fid FID
Specifies the Fabric ID of the logical switch for which the command is executed.
--fid all
Executes the specified command in all logical switch contexts configured on the
physical switch.
-force
Executes the specified command on all logical switches in your permission list
without prompting for confirmation.
-cmd "cmd [args]"
Specifies the command to be executed including command options if applicable.
The entire command string must be enclosed in double quotation marks.
EXAMPLES
To display switch information for a logical switch with FID 10:
switch:admin> fosexec --fid 10 -cmd "switchshow"
------------------------------------"switchshow" on FID 10
switchName:
switch_10
switchType:
66.1
switchState:
Online
switchMode:
Native
switchRole:
Subordinate
switchDomain:
1
switchId:
fffc01
switchWwn:
10:00:00:05:1e:41:5f:c2
zoning:
ON (lsan_cfg)
switchBeacon:
OFF
FC Router:
OFF
Allow XISL Use: ON
LS Attributes: [FID: 10, Base Switch: No, \
426
Fabric OS Command Reference
53-1003108-01
fosExec
2
Default Switch: No, Address Mode 0]
Index Slot Port Address Media Speed State
Proto
===================================================
0
1
0
640000
-N8
No_Module
FC
1
1
1
640100
-N8
No_Module
FC
2
1
2
640200
-N8
No_Module
FC
To enable port 5/0 on all logical switches:
switch:admin> fosexec --fid all -cmd "portenable 5/0"
--------------------------------------------------"portenable" on FID 128:
--------------------------------------------------"portenable" on FID 10:
A port or ports is/are not part of this switch.
--------------------------------------------------"portenable" on FID 20:
A port or ports is/are not part of this switch.
To display the firmware version for all logical switches:
switch:user> fosexec --fid all -cmd "firmwareshow -v"
LF permission does not exist for one or more \
logical switches.
Would you like to continue [Y/N] : y
-----------------------------------------"firmwareshow" on FID 10:
Appl
Primary/Secondary Versions
-----------------------------------------FOS
v7.0.0
v7.0.0
-----------------------------------------"firmwareshow" on FID 20:
Appl
Primary/Secondary Versions
-----------------------------------------FOS
Fabric OS Command Reference
53-1003108-01
v7.0.0
v7.0.0
427
2
fosExec
To display the switch name for all logical switches without confirmation:
switch:user> fosexec --fid all -force -cmd "switchname"
-----------------------------------"switchname" on FID 10:
switch_10
----------------------------------"switchname" on FID 20:
switch_20
SEE ALSO
428
setContext, userConfig
Fabric OS Command Reference
53-1003108-01
frameLog
2
frameLog
Displays information about discarded frames.
SYNOPSIS
framelog --disable
framelog --enable
framelog --clear
framelog --show [-txport [slot/]port]
[-rxport [slot/]port]
[-sid source_PID][-did destination_PID]
[-sfid fabric_ID] [-dfid fabric_ID>]
[-mode summary | dump] [-n num_items]
DESCRIPTION
Use this command to disable or re-enable the frame log, and to display detailed information about the
discarded frames logged by the frame log. The frame log stores information about frames discarded due
to certain reasons. Frame log sees information about only 20 discarded frames per second per chip on
the chassis. The only discard reason currently supported is timeout.
When frame drops occur on a switch, the frame log can help you identify to which flows the dropped
frames belong and zero in on the affected applications by finding out the end-points of the dropped
frame.
Use the --show option to display detailed information about the discarded frames that match the filter
criteria provided by this command. The --show option supports two viewing modes: summary and dump
mode. In summary mode, the command aggregates similar frames (those that have the same log
timestamp, TX port, RX port, SID, DID, SFID and DFID) without displaying the raw frame contents. In
dump mode, the command displays the raw frame contents, but the frames are not aggregated in the
manner of the summary mode. In either mode, you can specify additional filters to customize the number
and properties of the frames for closer examination.
When viewed in summary mode, the frame log displays the following information:
Log timestamp
The date and time when the frames described in this line of output were
discarded. This value is accurate to within one second, that is, the displayed
frames were not necessarily dropped at precisely the same time.
TX port
Egress port where the frames were bound to exit the chassis. A port displayed as
-1 (or -1/-1 on slot-based systems) indicates an internal port.
RX port
Ingress port where the frames entered the chassis. A port displayed as -1 (or -1/-1
on slot-based systems indicates an internal port.
SID
Source port ID in hexadecimal PID format.
DID
Destination port ID in hexadecimal PID format.
SFID
Source Fabric ID
DFID
Destination Fabric ID
Fabric OS Command Reference
53-1003108-01
429
2
frameLog
Type
Reason for the frame discard. Frames can be discarded for a variety of reasons.
The only discard reason currently handled by the frame log is timeout.
Count
The number of discarded frames logged in the frame log that have the log
timestamp, TX port, RX port, SID, DID, SFID and DFID values listed on this line of
output. Note that this count may be less than the actual number of such frames
discarded, because the frame log cannot log the details of all discarded frames.
When viewed in dump mode, the frame log displays the following information:
Log timestamp
The date and time when the frames described in this line of output were
discarded.
TX port
Egress port where the frames were bound to exit the chassis. A port displayed as
-1 (or -1/-1 on slot-based systems) indicates an internal port.
RX port
Ingress port where the frames were bound to enter the chassis. A port displayed
as -1 (or -1/-1 on slot-based systems indicates an internal port.
Type
Reason for the frame discard. Frames can be discarded for a variety of reasons.
The only discard reason currently handled by the frame log is timeout.
Frame contents
The first 64 bytes of the frame contents in hexadecimal format.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
The Frame Log operation is chassis-wide.
OPERANDS
This command has the following operands:
--disable
Disables logging of discarded frames, which is enabled by default. This command
clears the history of discarded frames and gathering of new information ceases.
When frame logging is disabled, only the --help and --enable operations are
permitted.
--enable
Enables logging of discarded frames after the feature was disabled.
--clear
Clears the stored history of discarded frames. This operation is permitted only
when the feature is enabled.
430
Fabric OS Command Reference
53-1003108-01
frameLog
2
--show
Prints a listing of details about stored frames that match the specified filter criteria.
This operation is permitted only when the feature is enabled. You can specify one
or more of the following options to filter the output. When used without operands,
the --show command displays the unfiltered output. This option supports
specifying that the TX port or RX port of displayed frames should be a backend
port.
-txport [slot/]port
Displays only the frames that were bound to exit by the specified egress port. The
-txport option accepts argument "-1" (for fixed-port switches) or "-1/-1" (for
modular switches). These stand for "any backend port". Using this notation, you
can select specifically those discarded frames that have a backend port in the TX
port field. Individual backend ports cannot be specified, only the quality of being a
backend port can be specified.
-rxport [slot/]port
Displays only the frames that entered the chassis on the specified port. The
-rxport option accepts argument "-1" (for fixed-port switches) or "-1/-1" (for
modular switches). These stand for "any backend port". Using this notation, you
can select specifically those discarded frames that have a backend port in the RX
port field. Individual backend ports cannot be specified, only the quality of being a
backend port can be specified.
-sid source_PID
Displays only the frames with the specified 24-bit source address in the FC
header. The port ID (PID) must be written in hexadecimal and must be prefixed by
0x.
-did destination_PID
Displays only the frames with the specified 24-bit destination address in the FC
header. The port ID (PID) must be written in hexadecimal and must be prefixed by
0x.
-sfid fabric_ID
Displays only the frames with the specified fabric ID as the source fabric ID.
-sdfid fabric_ID
Displays only the frames with the specified fabric ID as the destination fabric ID.
-mode summary | dump
Specifies the command output mode. In dump mode, the command prints the 64
bytes of frame contents. In summary mode, the frame contents are not displayed.
Summary mode is the default.
-n num_items
Displays the specified number of items. In summary mode, an item is a record of
frames with the same values of log timestamp, TX port, RX port, SID, DID, SFID
and DFID. Note that more frames may be represented in the lines of output than
specified in the num_items value, because one line can aggregate multiple frames
in summary mode. In dump mode, each item represents a single frame. The
default value of num_items is 20. The maximum value in summary mode is 1200,
and in dump mode it is 12,000.
EXAMPLES
To display eight lines of an unfiltered frame log view in summary mode:
switch:user> framelog --show -mode summary -n 8
=====================================================================
Mon Jan 31 23:54:59 UTC 2011
======================================================================
Log
TX
RX
Fabric OS Command Reference
53-1003108-01
431
2
frameLog
timestamp
port port SID
DID
SFID DFID Type
Count
======================================================================
Jan 31 23:49:37 2
2
0xfffffd 0xfffffd 1
1
timeout
1
Jan 31 23:49:37 2
1
0x051500 0x060100 1
1
timeout
4
Jan 31 23:49:37 2
0
0x051700 0x060000 1
1
timeout
4
Jan 31 23:49:36 2
1
0x051500 0x060100 1
1
timeout
3
Jan 31 23:49:36 2
0
0x051700 0x060000 1
1
timeout
3
Jan 31 23:49:35 2
1
0x051500 0x060100 1
1
timeout
2
To display the frame contents in dump mode:
switch:user> framelog --show -mode dump -n 4
====================================================================
Mon Jan 31 18:34:47 UTC 2011
====================================================================
Log
TX
RX
timestamp
port port Type
Frame contents (first 64 bytes)
====================================================================
Jan 31 18:34:46 7/32 7/33 timeout
00 03 a0 00 00 03 a1 00 00 28 00 00 00 00 00 00
80 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
SEE ALSO
432
Jan 31 18:34:46 7/32 7/33 timeout
00 03 a0 00 00
80 00 00 00 00
00 00 00 00 00
00 00 00 00 00
03
00
00
00
a1
00
00
00
00
00
00
00
00
00
00
00
28
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
Jan 31 18:34:46 7/32 7/33 timeout
00 03 a0 00 00
80 00 00 00 00
00 00 00 00 00
00 00 00 00 00
03
00
00
00
a1
00
00
00
00
00
00
00
00
00
00
00
28
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
Jan 31 18:34:46 7/32 7/33 timeout
00 03 a0 00 00
80 00 00 00 00
00 00 00 00 00
00 00 00 00 00
03
00
00
00
a1
00
00
00
00
00
00
00
00
00
00
00
28
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
00
None
Fabric OS Command Reference
53-1003108-01
fspfShow
2
fspfShow
Displays Fabric Shortest Path First (FSPF) protocol information.
SYNOPSIS
DESCRIPTION
fspfshow
Use this command to display FSPF protocol information and internal data structures of the FSPF
module. The command displays the following fields:
version
Version of the FSPF protocol.
domainID
Domain number of the local switch.
switchOnline
State of the local switch.
domainValid
TRUE if the domain of the local switch is currently confirmed.
isl_ports
Bit map of all ISL ports. Bit positions correspond to the default areas of the ports.
Bit 0 refers to default area of the switch, bit 1 refers to default area 1, and so forth.
trunk_ports
Bit map of all trunk slave ports.
f_ports
Bit map of all FX_Ports.
seg_ports
Bit map of all segmented ports.
active_ports
Bit map of all online ports.
minLSArrival
FSPF constant.
minLSInterval
FSPF constant.
LSoriginCount
Internal variable.
startTime
Start time of the FSPF task from boot time, in milliseconds.
fspfQ
FSPF input message queue.
fabP
Pointer to fabric data structure.
agingTID
Aging timer ID.
agingTo
Aging time out value in milliseconds.
lsrDlyTID
Link State Record delay timer ID.
Fabric OS Command Reference
53-1003108-01
433
2
fspfShow
lsrDelayTo
Link State Record delay time out value in milliseconds.
lsrDelayCount
Counter of delayed Link State Records.
ddb_sem
FSPF semaphore ID.
event_sch
FSPF scheduled events bit map.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display FSPF protocol information:
switch:admin> fspfshow
version
domainID
switchOnline
domainValid
isl_ports[0]
isl_ports[1]
isl_ports[2]
isl_ports[3]
isl_ports[4]
isl_ports[5]
isl_ports[6]
isl_ports[7]
isl_ports[8]
isl_ports[9]
isl_ports[10]
isl_ports[11]
isl_ports[12]
trunk_ports[0]
trunk_ports[1]
trunk_ports[2]
trunk_ports[3]
trunk_ports[4]
trunk_ports[5]
trunk_ports[6]
trunk_ports[7]
trunk_ports[8]
trunk_ports[9]
trunk_ports[10]
trunk_ports[11]
trunk_ports[12]
f_ports[0]
f_ports[1]
f_ports[2]
f_ports[3]
f_ports[4]
f_ports[5]
f_ports[6]
f_ports[7]
f_ports[8]
434
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
2
35
TRUE
TRUE
0x00000000
0x09020800
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0xf60c0000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x05030401
0x00000000
0x00008307
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
Fabric OS Command Reference
53-1003108-01
fspfShow
f_ports[9]
=
f_ports[10]
=
f_ports[11]
=
f_ports[12]
=
seg_ports[0]
=
seg_ports[1]
=
seg_ports[2]
=
seg_ports[3]
=
seg_ports[4]
=
seg_ports[5]
=
seg_ports[6]
=
seg_ports[7]
=
seg_ports[8]
=
seg_ports[9]
=
seg_ports[10]
=
seg_ports[11]
=
seg_ports[12]
=
active_ports[0] =
active_ports[1] =
active_ports[2] =
active_ports[3] =
active_ports[4] =
active_ports[5] =
active_ports[6] =
active_ports[7] =
active_ports[8] =
active_ports[9] =
active_ports[10]
active_ports[11]
active_ports[12]
minLSArrival
=
minLSInterval
=
LSoriginCount
=
startTime
=
fspfQ
=
fabP
=
agingTID
=
agingTo
=
lsrDlyTID
=
lsrDelayTo
=
lsrDelayCount
=
ddb_sem
=
fabP:
event_sch
SEE ALSO
2
0x00000000
0x00000000
0x00000000
0x00000000
0x00000002
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x05030403
0xff0e0800
0x00008307
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
0x00000000
= 0x00000000
= 0x00000000
= 0x00000000
3000
5000
0
0
0x10db7998
0x10dc19a0
0x10ee21b0
10000
0x10ee32e8
5000
0
0x10dc19b0
= 0x0
bcastShow, topologyShow, uRouteShow
Fabric OS Command Reference
53-1003108-01
435
2
fwAlarmsFilterSet
fwAlarmsFilterSet
Enables or disables alarms for Fabric Watch.
SYNOPSIS
DESCRIPTION
NOTES
fwalarmsfilterset [mode]
Use this command to configure alarm filtering for Fabric Watch. By turning off the alarms, all
nonenvironment class alarms are suppressed. By turning on the alarms, all class alarms are generated.
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
mode
Specify 1 to enable the alarms, 0 to disable the alarms. If no operand is specified,
the default value is 0 (alarms deactivated). This operand is optional; if omitted, this
command disables the alarms.
EXAMPLES
To enable alarms in Fabric Watch:
switch:admin> fwalarmsfilterset
FW: Alarms are already disabled
switch:admin> fwalarmsfilterset 1
FW: Alarms are already enabled
SEE ALSO
436
fwAlarmsFilterShow
Fabric OS Command Reference
53-1003108-01
fwAlarmsFilterShow
2
fwAlarmsFilterShow
Displays alarm filtering for Fabric Watch.
SYNOPSIS
DESCRIPTION
NOTES
fwalarmsfiltershow
Use this command to display whether alarm filtering is enabled or disabled.
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the status of alarm filtering in Fabric Watch:
switch:user> fwalarmsfiltershow
FW: Alarms are enabled
switch:user> fwalarmsfiltershow
FW: Alarms are disabled
SEE ALSO
fwAlarmsFilterSet
Fabric OS Command Reference
53-1003108-01
437
2
fwClassInit
fwClassInit
Initializes all classes under Fabric Watch.
SYNOPSIS
DESCRIPTION
NOTES
fwclassinit
Use this command to initialize all classes under Fabric Watch. The command should only be used after
installing a Fabric Watch license to start licensed Fabric Watch classes. Refer to the Fabric Watch
Administrator's Guide for a list of supported Fabric Watch classes.
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To initialize all classes under Fabric Watch:
switch:admin> fwclassinit
fwClassInit: Fabric Watch is updating...
fwClassInit: Fabric Watch has been updated.
SEE ALSO
438
fwConfigReload, fwHelp, portFencing, portThConfig, thConfig, sysMonitor
Fabric OS Command Reference
53-1003108-01
fwConfigReload
2
fwConfigReload
Reloads the Fabric Watch configuration.
SYNOPSIS
DESCRIPTION
NOTES
fwconfigreload
Use this command to reload the Fabric Watch configuration. This command should only be used after
downloading a new Fabric Watch configuration file from a host.
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To reload the saved Fabric Watch configuration:
switch:admin> fwconfigreload
fwConfigReload: Fabric Watch configuration reloaded
SEE ALSO
configDownload, configUpload, fwClassInit, fwHelp
Fabric OS Command Reference
53-1003108-01
439
2
fwFruCfg
fwFruCfg
Displays or modifies FRU state alert configuration.
SYNOPSIS
DESCRIPTION
NOTES
fwfrucfg [--show]
Use this command to configure states and actions for field-replaceable units (FRUs) and small
form-factor pluggables (SFPs). Based on these configuration settings, Fabric Watch generates actions
when a FRU or SFP state changes. For SFPs, Fabric Watch monitors state changes in following events:
SFP inserted, SPP removed, SFP faulty. When used without operand, this command interactively
prompts for user input. To configure email alerts, use fwMailCfg. This command is not applicable to
platforms that do not support FRUs or SFPs.
This command requires a Fabric Watch license.
The OFF state (8) is only applicable to FANs on the Brocade DCX and DCX-4S chassis and on the
Brocade 5300 switch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operand:
--show
Displays the current FRU configuration setting. This operand is optional; if
omitted, the configuration prompt displays.
EXAMPLES
To change the FRU state alert configuration:
switch:admin> fwfrucfg
The current FRU configuration:
Alarm State
Alarm Action
----------------------------------------------Slot
1
1
Power Supply
1
1
Fan
1
1
WWN
1
1
SFP
0
0
Note that the value 0 for a parameter means that
it is NOT used in the calculation
Configurable Alarm States are:
Absent-1, Inserted-2, On-4, Off-8, Faulty-16
Configurable Alarm Actions are:
Errlog-1, E-mail-16
Slot Alarm State: (0..31) [1]
Slot Alarm Action: (0..17) [1]
Power Supply Alarm State: (0..31) [1]
Power Supply Alarm Action: (0..17) [1]
Fan Alarm State: (0..31) [1]
Fan Alarm Action: (0..17) [1]
440
Fabric OS Command Reference
53-1003108-01
fwFruCfg
WWN
WWN
SFP
SFP
Fru
SEE ALSO
2
Alarm State: (0..31) [1]
Alarm Action: (0..17) [1]
Alarm State: (0..19) [0]
Alarm Action: (0..17) [0]
configuration left unchanged
fwHelp, fwMailCfg, sfpShow
Fabric OS Command Reference
53-1003108-01
441
2
fwHelp
fwHelp
Displays Fabric Watch command information.
SYNOPSIS
DESCRIPTION
NOTES
fwhelp
Use this command to display the commands that configure Fabric Watch.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display a summary of Fabric Watch commands:
switch:user> fwhelp
fanshow
fmconfig
fwalarmsfilterset
fwalarmsfiltershow
fwclassinit
fwconfigreload
fwfrucfg
fwhelp
fwmailcfg
fwportdetailshow
fwsamshow
fwset
fwsettocustom
fwsettodefault
portfencing
portthconfig
sensorshow
switchstatuspolicyset
switchstatuspolicyshow
switchstatusshow
sysmonitor
tempshow
thconfig
thmonitor
SEE ALSO
442
Print fan status
Configure Frame Monitors
Configure alarms filtering for
Fabric Watch
Show alarms filtering for Fabric Watch
Initialize all Fabric Watch classes
Reload Fabric Watch configuration
Configure FRU state and notification
Print Fabric Watch help info
Configure Fabric Watch Email Alert
Create a report with detailed
port information
Show availability monitor information
Set port persistence time
Set boundary & alarm level to custom
Set boundary & alarm level to default
Configure Fabric Watch port fencing
feature
Configure Fabric Watch port threshold
monitor
Display sensor readings
Set policy parameters for overall
switch status
Print policy parameters for overall
switch status
Print overall switch status
Configure system memory usage monitor
Print temperature readings
Configure Fabric Watch thresholds
Configure Fabric Watch threshold monitors
None
Fabric OS Command Reference
53-1003108-01
fwMailCfg
2
fwMailCfg
Displays and configures Fabric Watch email alerts.
SYNOPSIS
DESCRIPTION
fwmailcfg
Use this command to display or modify the configuration and status of the Fabric Watch email alert on
the switch.
Switch elements monitored by Fabric Watch are divided into classes, and e-mail alerts are based on the
classes. Each class can configure up to five e-mail addresses as the alert message's receiver. Multiple
e-mail addresses must be separated by a comma. The e-mail addresses must conform to standard
syntax string@domain.suffix. Default domains are not automatically appended. Invalid e-mail addresses
are rejected. "NONE" is the default address and a valid input parameter.
In Access Gateway mode, only the following classes are supported.
•
•
•
•
•
•
Environment class
SFP class
Port class
F/FL Port (Optical) class
F/FL Port (Copper) class (embedded platforms only)
Resource class
For an e-mail alert to function correctly, add the CP0 and CP1 IP addresses and host names to DNS and
also set the domain name and name server. The ipAddrShow and dnsConfig commands can be used
to set and verify this information.
NOTES
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To configure email settings:
switch:admin> fwmailcfg
1 : Show Mail Configuration Information
2 : Disable Email Alert
3 : Enable Email Alert
4 : Send Test Mail
5 : Set Recipient Mail Address for Email Alert
6 : Relay Host IP Configuration
7 : Quit
Select an item => : (1..7) [7]1
Config Show Menu
-------------------------------------1 : Environment class
2 : SFP class
3 : Port class
4 : Fabric class
5 : E-Port class
6 : F/FL Port (Optical) class
7 : Alpa Performance Monitor class
8 : End-to-End Performance Monitor class
Fabric OS Command Reference
53-1003108-01
443
2
fwMailCfg
9 : Filter Performance Monitor class
10 : Security class
11 : Resource Monitor class
12 : FRU Class
13 : Quit
Select an item => : (0..13) [11] 1
Mail Recipient information
-------------------------------------------Email Alert
= disabled
Mail Recipients = NONE
-------------------------------------------1 : Show Mail Configuration Information
2 : Disable Email Alert
3 : Enable Email Alert
4 : Send Test Mail
5 : Set Recipient Mail Address for Email Alert
6 : Relay Host IP Configuration
7 : Quit
Select an item => : (1..7) [7]5
Mail Config Menu
-------------------------------------1 : Environment class
2 : SFP class
3 : Port class
4 : Fabric class
5 : E-Port class
6 : F/FL Port (Optical) class
7 : Alpa Performance Monitor class
8 : End-to-End Performance Monitor class
9 : Filter Performance Monitor class
10 : Security class
11 : Resource Monitor class
12 : FRU Class
13 : Quit
Select an item => : (0..13) [11] 1
Mail To: [NONE] dino@switchcorp.com,sys@switchcorp.com,\
info@switchcorp.com,dduck@disneyland.com,mm@gmail.com
Email Alert configuration succeeded!
To configure Fabric Watch e-mail alerts in Access Gateway mode:
switch:admin> fwmailcfg
1 : Show Mail Configuration Information
2 : Disable Email Alert
3 : Enable Email Alert
4 : Send Test Mail
5 : Set Recipient Mail Address for Email Alert
6 : Relay Host IP Configuration
7 : Quit
Select an item => : (1..7) [7] 1
Config Show Menu
___________________________
1 : Environment class
2 : SFP class
3 : Port class
444
Fabric OS Command Reference
53-1003108-01
fwMailCfg
2
4 : F/FL Port (Optical) class
5 : Resource class
6 : quit
Select a class => : (1..6) [6] 6
Mail Recipient Information
____________________________________
Email Alert
= disabled
Mail Recipient
= NONE
1 : Show Mail Configuration Information
2 : Disable Email Alert
3 : Enable Email Alert
4 : Send Test Mail
5 : Set Recipient Mail Address for Email Alert
6 : Quit
Select an item => : (1..6) [6] 5
Mail Config Menu
___________________________
1 : Environment class
2 : SFP class
3 : Port class
4 : F/FL Port (Optical) class
5 : Resource class
6 : Quit
Select an item => : (1..6) [6] 1
Mail To: [NONE] jpaul@brocade.com
Email Alert configuration succeeded!
SEE ALSO
dnsConfig, fwHelp, ipAddrSet, ipAddrShow
Fabric OS Command Reference
53-1003108-01
445
2
fwPortDetailShow
fwPortDetailShow
Displays the port information for specified user ports.
SYNOPSIS
DESCRIPTION
fwportdetailshow [--p port] | [--s portState]
Use this command to print the overall status of a specified port. The output of this command is different
for IPv4 and IPv6 addresses. The overall status is calculated based on the following contributors:
Port Errors
LFA
The number of link loss occurrences exceeding the limit for the time period.
LSY
The number of sync loss occurrences exceeding the limit for the time period.
LSI
The number of signal loss occurrences exceeding the limit for the time period.
PER
The number of protocol errors exceeding the limit for the time period
INW
The number of invalid words exceeding the limit for the time period
CRC
The number of invalid CRC errors exceeding the limit for the time period
PSC
The port hardware state changed too often.
BLP
Buffer limited port
SFP Errors
STM
The SFP temperature is out of range.
SRX
The SFP receive power is out of range.
STX
The SFP transmit power is out of range.
SCU
The SFP current is out of range.
SVO
The SFP voltage is out of range.
Overall status
Healthy
Every contributor is healthy.
Marginal
One or more contributors are in this status.
Faulty
Faulty hardware.
Offline
The port has no connectivity or is disabled.
If the overall status is not healthy, the contributing factors also are listed.
446
Fabric OS Command Reference
53-1003108-01
fwPortDetailShow
2
When used without operands, this command displays information for all ports.
NOTES
This command requires a Fabric Watch license.
Port errors are not supported for virtual ports and SFP errors are not applicable for virtual ports.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--p port
Displays a port detail report for the specified port.
--s portState
Displays a port detail report for the specified portState. Valid portState entries
include the following:
h
Report based on all healthy ports.
m
Report based on all marginal ports.
f
Report based on all faulty ports.
o
Report based on all offline ports.
EXAMPLES
To retrieve a port detail report for a switch configured with an IPv6 address:
switch:user> fwportdetailshow
Port Detail Report
\
Report time: 09/11/2006 05:51:15 PM
Switch Name:
switch
IP address:
1080::8:800:200C:417A
Port Exception report [by All]
--------Port-Errors-----------Port# Type State
Dur(H:M) LFA LSY LSI PER INW \
-------------------------------------------------\
000
001
002
003
004
U
E
L
U
U
OFFLINE
HEALTHY
HEALTHY
OFFLINE
OFFLINE
080:24
073:22
080:24
080:24
002:53
-
-
-
-
-
\
\
\
\
\
-----SFP-Errors---CRC PSC BLP STM SRX STX SCU SVO
------------------------------(output truncated)
Fabric OS Command Reference
53-1003108-01
447
2
fwPortDetailShow
To retrieve a port detail report for all ports in healthy state:
switch:user> fwportdetailshow --s h
Port Detail Report
\
Report time: 05/21/2007 11:22:58 PM
Switch Name:
switch
IP address:
192.168.163.237
Port Exception report [by Healthy]
--------Port-Errors-----------Port# Type State
Dur(H:M) LFA LSY LSI PER INW \
------------------------------------------------\
001
F HEALTHY
409:09
- \
014
F HEALTHY
409:09
- \
015
E HEALTHY
409:09
- \
-----SFP-Errors---CRC PSC BLP STM SRX STX SCU SVO
-------------------------------
SEE ALSO
448
switchStatusShow
Fabric OS Command Reference
53-1003108-01
fwSamShow
2
fwSamShow
Generates switch availability monitor (SAM) report.
SYNOPSIS
DESCRIPTION
NOTES
fwsamshow
Use this command to display a switch availability monitor (SAM) report. This report displays uptime and
downtime for each port and enables you to check if a particular port is failing more often than the others.
The information displayed includes total uptime, total downtime, number of faulty occurrences, and total
percent of downtime for each port.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command requires a Fabric Watch license.
OPERANDS
None
EXAMPLES
To generate a SAM report on an eighty-port switch:
switch:user> fwsamshow
Total
Total
Port Type Up Time Down Time
Occurrence Offline Time
(Percent) Percent)
(Times)
(Percent)
========================================================
0
U
0
0
0
100
1
U
0
0
0
100
2
U
0
0
0
100
3
U
0
0
0
100
4
U
0
0
0
100
5
U
0
0
0
100
6
F
100
0
0
0
7
U
0
0
0
100
8
U
0
0
0
100
9
U
0
0
0
100
10
U
0
0
0
100
11
U
0
0
0
100
12
U
0
0
0
100
13
U
0
0
0
100
14
U
0
0
0
100
15
U
0
0
0
100
16
F
100
0
0
0
17
F
100
0
0
0
18
F
100
0
0
0
19
F
100
0
0
0
20
U
00
0
100
100
21
U
0
0
0
100
22
U
0
0
0
100
23
U
0
0
0
100
(output truncated)
SEE ALSO
portShow, switchShow
Fabric OS Command Reference
53-1003108-01
449
2
fwSet
fwSet
Sets port persistence time.
SYNOPSIS
DESCRIPTION
NOTES
fwset --port --persistence seconds
Use this command to set port persistence time, a parameters controlled by Fabric Watch. Port
persistence time specifies the time in seconds during which a port must persistently be in a marginal
state before being labeled as such. port persistence is a switch-wide parameter. Use portThconfig to
display port persistence time.
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--port --persistence seconds
Specifies the time, in seconds, during which a port must be persistently in a
marginal state before being recognized as such.
EXAMPLES
To set the port persistence time to 18 seconds:
switch:user> fwset --port --persistence 18
SEE ALSO
450
fwHelp, portThConfig
Fabric OS Command Reference
53-1003108-01
fwSetToCustom
2
fwSetToCustom
Sets Fabric Watch thresholds and alarm levels to custom values.
SYNOPSIS
DESCRIPTION
fwsettocustom
Use this command to set threshold and alarm levels to custom values for all Fabric Watch classes and
areas.
Fabric Watch uses two types of settings: factory default settings and user-defined custom settings.
•
Factory default settings are automatically enabled. These settings vary depending on hardware
platform, and cannot be modified.
•
For some Fabric Watch parameters, you can create custom configurations to suit your unique
environment.
The fwSetToCustom command allows you to switch from default to custom settings. The command
assumes that a set of user-defined thresholds have been configured prior to executing the
fwSetToCustom command. If no user-defined settings exist, this command reapplies the default values.
Use the advanced configuration option provided with the portThConfig, thConfig, and sysMonitor
commands to view and modify custom and default values for specified classes and areas in Fabric
Watch. For specific configuration procedures, refer to the Fabric Watch Administrator's Guide.
NOTES
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To apply configured custom settings to all Fabric Watch classes and areas:
switch:admin> fwsettocustom
Committing configuration...done.
To view the current Fabric Watch configuration for the environment class:
switch:admin> sysmonitor --show env
Class: ENV
Area
: TEMP
ThLevel : Cust (Applied)
ActLevel: Cust (Applied)
High
:
Custom:
TimeBase: None
Value
: 90
Trigger : Above Action:
Trigger : Below Action:
Default:
TimeBase: None
Value
: 65
Trigger : Above Action:
Trigger : Below Action:
Low:
Custom:
TimeBase: None
Value
:32
Fabric OS Command Reference
53-1003108-01
Raslog,SNMP
None
Raslog,SNMP
Raslog,SNMP
451
2
fwSetToCustom
Trigger :
Trigger :
Default:
TimeBase:
Value
:
Trigger :
Trigger :
Buffer:
Custom:
Value
:
Default:
Value
:
Above Action: None
Below Action: Raslog,SNMP
None
0
Above Action: None
Below Action: Raslog,SNMP
20
10
Class: RESOURCE
Area
: FLASH
ThLevel : Cust (Applied)
ActLevel: Def
High
:
Custom:
TimeBase: None
Value
: 110
Trigger : Above Action: Raslog,SNMP
Trigger : Below Action: Raslog
Default:
TimeBase: None
Value
: 90
Trigger : Above Action: Raslog,SNMP
Trigger : Below Action: Raslog
Low:
Custom:
TimeBase: None
Value
: 15
Trigger : Above Action: None
Trigger : Below Action: Raslog,SNMP
Default:
TimeBase: None
Value
: 0
Trigger : Above Action: None
Trigger : Below Action: Raslog,SNMP
Buffer:
Custom:
Value
: 20
Default:
Value
: 0
SEE ALSO
452
fwSetToDefault, fwHelp, portThConfig, thConfig, sysMonitor
Fabric OS Command Reference
53-1003108-01
fwSetToDefault
2
fwSetToDefault
Returns Fabric Watch thresholds and alarm levels to default values.
SYNOPSIS
DESCRIPTION
fwsettodefault
Use this command to return Fabric Watch thresholds and alarm levels to defaults for all classes and
areas in Fabric Watch.
Fabric Watch uses two types of settings: factory default settings and user-defined custom settings.
•
Factory default settings are automatically enabled. These settings vary depending on hardware
platform and cannot be modified.
•
For some settings, you can create custom threshold configurations to suit your unique environment.
The fwSetToDefault command reapplies the Fabric Watch default configuration for all classes and
areas. Use the advanced configuration option provided with the portThConfig, thConfig, and
sysMonitor commands to view and modify custom and default values for specified classes and areas in
Fabric Watch. For specific configuration procedures, refer to the Fabric Watch Administrator's Guide.
NOTES
This command requires a Fabric Watch license.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To return alarm levels to default values:
switch:admin> fwsettodefault
Committing configuration...done.
To view the current Fabric Watch configuration for the environment class:
switch:admin> sysmonitor --show env
Class: ENV
Area
: TEMP
ThLevel : Def
ActLevel: Def
High
:
Custom:
TimeBase: None
Value
: 90
Trigger : Above Action:
Trigger : Below Action:
Default:
TimeBase: None
Value
: 65
Trigger : Above Action:
Trigger : Below Action:
Low:
Custom:
TimeBase: None
Value
:32
Trigger : Above Action:
Trigger : Below Action:
Default:
TimeBase: None
Fabric OS Command Reference
53-1003108-01
Raslog,SNMP
None
Raslog,SNMP
Raslog,SNMP
None
Raslog,SNMP
453
2
fwSetToDefault
Value
: 0
Trigger : Above Action: None
Trigger : Below Action: Raslog,SNMP
Buffer:
Custom:
Value
Default:
Value
: 20
: 10
Class: RESOURCE
Area
: FLASH
ThLevel : Def
ActLevel: Def
High
:
Custom:
TimeBase:
Value
:
Trigger :
Trigger :
Default:
TimeBase:
Value
:
Trigger :
Trigger :
Low:
Custom:
TimeBase:
Value
:
Trigger :
Trigger :
Default:
TimeBase:
Value
:
Trigger :
Trigger :
Buffer:
Custom:
Value
:
Default:
Value
:
SEE ALSO
454
None
110
Above Action: Raslog,SNMP
Below Action: Raslog
None
90
Above Action: Raslog,SNMP
Below Action: Raslog
None
15
Above Action: None
Below Action: Raslog,SNMP
None
0
Above Action: None
Below Action: Raslog,SNMP
20
0
fwSetToCustom, fwHelp, portThConfig, thConfig, sysMonitor
Fabric OS Command Reference
53-1003108-01
gePortErrShow
2
gePortErrShow
Displays error statistics of Gigabit Ethernet (GbE) port and XGE ports.
SYNOPSIS
geporterrshow
geporterrshow --help
DESCRIPTION
Use this command to display error statistics of Gigabit Ethernet (GbE) ports on the Brocade 7800
extension switch and on the Brocade FX8-24 extension blade. Values for the following parameters are
displayed:
frames tx
Number of frames transmitted (Tx).
frames rx
Number of frames received (Rx).
crc err
Number of CRC errors.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
--help
Displays command usage.
EXAMPLES
To display error statistics:
switch:admin> geporterrshow
frames
crc
tx
rx
err
====================
1/ge0
1/ge1
1/ge2
1/ge3
1/ge4
1/ge5
1/ge6
1/ge7
1/ge8
1/ge9
SEE ALSO
:
:
:
:
:
:
:
:
:
:
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
portCfgShow, portErrShow
Fabric OS Command Reference
53-1003108-01
455
2
h
h
Displays shell history.
SYNOPSIS
h
history
DESCRIPTION
OPERANDS
EXAMPLES
Use this command to view the shell history. The shell history mechanism is similar to the UNIX shell
history facility. The h command displays the 20 most recent commands typed into the shell; the oldest
commands are replaced as new ones are entered.
None
To display previous shell commands:
switch:admin> h
1 version
2 switchshow
3 portdisable 2
4 portenable 2
5 switchshow
SEE ALSO
456
None
Fabric OS Command Reference
53-1003108-01
haDisable
2
haDisable
Disables the High Availability feature.
SYNOPSIS
hadisable
DESCRIPTION
Use this command to disable the High Availability (HA) feature on a switch. If the HA feature is already
disabled, this command does nothing.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable the High Availability feature:
switch:admin> hadisable
HA is disabled
SEE ALSO
haEnable, haShow
Fabric OS Command Reference
53-1003108-01
457
2
haDump
haDump
Displays High Availability status information.
SYNOPSIS
DESCRIPTION
hadump
Use this command to display information about the status of the High Availability (HA) feature on a switch
or a chassis. This command displays the following information:
•
•
•
•
•
•
•
•
•
•
Time Stamp
Local CP state (slot number and CP ID)
Remote CP state (slot number and CP ID)
Type of recovery (warm or cold)
High Availability (enabled or disabled)
Heartbeat (up or down)
Health of standby CP
HA synchronization status
IP and Fibre Channel addresses configured for the switch or chassis.
Additional internal HA state information, subject to change.
The health of the standby CP is defined as follows:
Healthy
The standby CP is running and the background health diagnostic has not detected
any errors.
Failed
The standby CP is running, but the background health diagnostic has discovered
a problem with the blade. Check the logs to determine an appropriate course of
action. Failover is disabled until the standby CP is repaired. Information about the
failing device in the standby CP is displayed.
Unknown
The standby CP health state is unknown because the standby CP does not exist,
heartbeat is down, or Health Monitor detects a configuration file error.
The High Availability synchronization status is defined as follows:
HA State synchronized
The system is currently fully synchronized. If a failover becomes necessary, it is
nondisruptive.
HA State not in sync
The system is unable to synchronize the two control processors (CPs) because
the standby CP is faulty, an haSyncStop command was issued, or a system error
occurred. If a failover becomes necessary at this time, active CP reboots and the
failover is disruptive.
458
Fabric OS Command Reference
53-1003108-01
haDump
NOTES
2
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To view information about the High Availability feature status on a Brocade DCX 8510-8:
switch:admin> hadump
--------------------------------------TIME_STAMP: Mar 30 12:57:35.109173
--------------------------------------Local CP (Slot 7, CP1): Active, Warm Recovered
Remote CP (Slot 6, CP0): Standby, Healthy
HA enabled, Heartbeat Up, HA State synchronized
CHASSIS
Ethernet IP Address: 10.20.114.57
Ethernet Subnetmask: 255.255.240.0
CP0
Ethernet IP Address: 10.20.114.58
Ethernet Subnetmask: 255.255.240.0
Host Name: cp0
Gateway IP Address: 10.20.112.1
CP1
Ethernet IP Address: 10.20.114.59
Ethernet Subnetmask: 255.255.240.0
Host Name: cp1
Gateway IP Address: 10.20.112.1
Backplane IP address of CP0 : 10.0.0.5
Backplane IP address of CP1 : 10.0.0.6
IPv6 Autoconfiguration Enabled: Yes
Local IPv6 Addresses:
IPv6 Gateways:
--------------------------------------TIME_STAMP: Mar 30 12:57:37.31282
--------------------------------------== Service ==
chassis0:0(8.0)
major:
8
part:
0
lo:
0
role:
2
id:
0
dump:
3
epoch:
3
log:
0
block:
0
bits:
321
recov:
0
index:
14
upper:
14
coldnum:
3
warmnum:
14
stbynum:
4
stat:
4
prevstat:
4
sv_winsz:
64
nscm:
10
== Config ==
(Output truncated)
SEE ALSO
haFailover, haShow
Fabric OS Command Reference
53-1003108-01
459
2
haEnable
haEnable
Enables the High Availability feature.
SYNOPSIS
DESCRIPTION
haenable
Use this command to enable the High Availability (HA) feature on a switch. If the HA feature is already
enabled, this command has no effect.
If the HA feature is disabled, this command enables it. The standby CP reboots as part of the process.
The command displays a warning message and prompts for confirmation before rebooting the CP.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To enable the High Availability feature on a Brocade DCX 8510-8:
switch:admin> haenable
Warning: This command will enable the HA. It will reboot the standby
CP and require all telnet, secure telnet, and SSH sessions to the
standby CP to be restarted
Are you sure you want to go ahead
y
[y/n]?y
To verify that High Availability is enabled:
switch:admin> hashow
Local CP (Slot 7, CP1): Active, Warm Recovered
Remote CP (Slot 6, CP0): Standby, Healthy
HA enabled, Heartbeat Up, HA State synchronized
SEE ALSO
460
haDisable, reboot
Fabric OS Command Reference
53-1003108-01
haFailover
2
haFailover
Forces the failover mechanism so that the standby control processor (CP) becomes the active CP.
SYNOPSIS
hafailover
DESCRIPTION
Use this command to force the failover mechanism to occur so that the standby CP becomes the active
CP. In case the active and standby CPs are not synchronized or the system is not in redundant mode, the
command aborts.
NOTES
When High Availability (HA) synchronization is enabled and the CPs are in sync, the port traffic light does
not flash during the failover, even while traffic is continuing to flow.
This command is supported only on dual-CP systems.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To force the failover of the active CP to the standby CP in the switch:
switch:admin> hafailover
Local CP (Slot 7, CP1): Active, Warm Recovered
Remote CP (Slot 6, CP0): Standby, Healthy
HA enabled, Heartbeat Up, HA State synchronized
Warning: This command is being run on a redundant control processor(CP)
system, and this operation will cause the active CP to reset.
Therefore all existing telnet sessions are required to be restarted.
Are you sure you want to fail over to the standby CP [y/n]?
SEE ALSO
haDisable, haEnable, haShow
Fabric OS Command Reference
53-1003108-01
461
2
haShow
haShow
Displays control processor (CP) status.
SYNOPSIS
DESCRIPTION
hashow
Use this command to display the control processor status. The display includes the following information:
•
•
•
•
•
•
Local CP state (slot number and CP ID), warm or cold, recovering or recovered.
Remote CP state (slot number and CP ID).
High Availability (enabled or disabled).
Heartbeat (up or down).
Health of standby CP
HA synchronization status
The health of the standby CP is defined as follows:
Healthy
The standby CP is running and the background health diagnostic has not detected
any errors.
Failed
The standby CP is running, but the background health diagnostic has discovered
a problem with the blade. Check the logs to determine the appropriate action.
Failover is disabled until the standby CP is repaired. Information about the failing
device in the standby CP is displayed.
Unknown
The standby CP health state is unknown because of one of the following reasons:
the standby CP does not exist, Heartbeat is down, or the Health Monitor has
detected a configuration file error.
The High Availability synchronization status is defined as follows:
HA State synchronized
The system is currently fully synchronized. If a failover becomes necessary, it is
nondisruptive.
HA State not in sync
The system is unable to synchronize the two CPs. This may be caused by one or
more of the following conditions:
•
The haFailover command was issued. In this case the "HA State not in sync"
state is transitory.
• The standby CP is faulty.
• The haSyncStop command was issued.
• A system error occurred.
If a failover becomes necessary while the CPs are not in sync, the standby CP
reboots, and the failover is disruptive.
NOTES
This command may not be supported on nonbladed systems.
Slot numbers for CP1 and CP0 vary depending on the hardware platform. On the Brocade DCX and DCX
8510-8, CP0 is in slot 6 and CP1 is in slot 7. On the Brocade DCX-4S, and DCX 8510-4, CP0 is in slot 4
and CP1 is in slot 5.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
462
Fabric OS Command Reference
53-1003108-01
haShow
OPERANDS
None
EXAMPLES
To display CP status on a Brocade DCX 8510-8 with a healthy standby CP:
2
switch:admin> hashow
Local CP (Slot 7, CP1) : Active, Warm Recovered
Remote CP (Slot 6, CP0) : Standby, Healthy
HA Enabled, Heartbeat Up, HA State Synchronized
SEE ALSO
haDisable, haEnable, haFailover
Fabric OS Command Reference
53-1003108-01
463
2
haSyncStart
haSyncStart
Enables High Availability state synchronization.
SYNOPSIS
DESCRIPTION
hasyncstart
Use this command to enable the High Availability (HA) state synchronization.
After issuing haSyncStop, the switch does not go back to sync start unless you perform one of the
following actions: reboot the active CP, reboot the standby CP, insert a new standby CP (blade), or issue
the haSyncStart command The time it takes for the HA sync to complete depends on the system
configuration. The HA sync timeout is set to 10 minutes.
NOTES
EXAMPLES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
To enable the HA state synchronization:
switch:admin> hasyncstart
SEE ALSO
464
haFailover, haShow, haSyncStop
Fabric OS Command Reference
53-1003108-01
haSyncStop
2
haSyncStop
Disables High Availability state synchronization.
SYNOPSIS
DESCRIPTION
hasyncstop
Use this command to temporarily disable High Availability (HA) synchronization.
After issuing haSyncStop, the switch does not go back to sync start unless you perform one of the
following actions: reboot the active CP, reboot the standby CP, insert a new standby CP (blade), or issue
the haSyncStart command The time it takes for the HA sync to complete depends on the system
configuration. The HA sync timeout is set to 10 minutes.
NOTES
Disabling HA synchronization may cause failover to be disruptive.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable the HA state synchronizing process:
switch:admin> hasyncstop
SEE ALSO
haFailover, haShow, haSyncStart
Fabric OS Command Reference
53-1003108-01
465
2
help
help
Displays command help information.
SYNOPSIS
help [command]
help [-p | -page]
help --help
DESCRIPTION
Use this command without operands to display an alphabetical listing of commands for which help is
available. When used without an operand, the command listing displays without page break.
Pipe the output through the Unix grep command to filter the output.
Use the -page operand to display the commands for which help is available one page at a time. Press
Enter to go to the next page. When using help with the -page option, you can search for specific strings
by entering a forward slash, followed by a text string, for example /zone.
The help listing includes only commands that are available to the current user; command availability may
vary depending on the following conditions:
•
•
•
Login user role
License key
Hardware platform
To access help information for a specific command, enter the command name as an operand.
Commands ending in "Help" display grouped commands for a particular subsystem; for example, the
diagHelp command displays a list of diagnostic commands.
OPERANDS
This command has the following operands:
command
Specifies the name of the command for which to display help information. This
operand is optional.
p | -page
Displays help output with page breaks.
--help
Displays the command usage.
EXAMPLES
To display a listing of commands for which help is available (with page breaks):
switch:admin> help -p
aaaconfig
Configure RADIUS for AAA services
ad
Specifies all administration domain
(AD)-levl operations
ag
Configure the Access Gateway feature
agshow
Displays the Access Gateway information
registered with the fabric
aliadd
Add a member to a zone alias
alicreate
Create a zone alias
alidelete
Delete a zone alias
aliremove
Remove a member from a zone alias
alishow
Print zone alias information
aptpolicy
Get and set Advanced Performance
466
Fabric OS Command Reference
53-1003108-01
help
auditcfg
auditdump
(output truncated)
2
Tuning policy
Modifies and displays audit log filter
configuration.
Display audit log
To search for the string "zone" while paging is enabled (enter /zone after issuing the command):
switch:admin> help -p
aaaconfig
Configure RADIUS for AAA services
ad
Specifies all administration domain
(AD)-level operations
ag
Configure the Access Gateway feature
agshow
Displays the Access Gateway information
registere with the fabric
aliadd
Add a member to a zone alias
alicreate
Create a zone alias
alidelete
Delete a zone alias
aliremove
Remove a member from a zone alias
alishow
Print zone alias information
aptpolicy
Get and set Advanced Performance Tuning
policy
auditcfg
Modifies and displays audit log filter
configuration.
auditdump
Display audit log
authutil
Get and set configuration
backplanetest
Backplane connection test for multi-blade
systems.
backport
Test for back-end ASIC pair to ASIC pair links.
bannerset
Set security banner
bannershow
Display security banner
bcastshow
Display broadcast routing information
Type <CR> or <SPACE BAR> to continue, <q> to stop
/zone
aliadd
Add a member to a zone alias
alicreate
Create a zone alias
alidelete
Delete a zone alias
aliremove
Remove a member from a zone alias
alishow
Print zone alias information
aptpolicy
Get and set Advanced Performance Tuning policy
auditcfg
Modifies and displays audit log filter
configuration.
(output truncated)
To filter the output with the grep command:
switch:admin> help | grep errshow
errshow
Print error log
porterrshow
Print port summary
switch:admin>
SEE ALSO
diagHelp, fwHelp, perfHelp, routeHelp, zoneHelp
Fabric OS Command Reference
53-1003108-01
467
2
historyLastShow
historyLastShow
Displays the latest entry in the field replaceable unit (FRU) history log.
SYNOPSIS
DESCRIPTION
historylastshow
Use this command to display the latest entry of the history log, which records insertion and removal
events for field-replaceable units (FRUs), such as blades, power supplies, fans, and world wide name
(WWN) cards. The type of FRU supported depends on the hardware platform.
Each history record contains three lines of information. The first line of each record contains the following
fields:
Object type
On standalone platforms: FAN, POWER SUPPLY, WWN (WWN card), or
UNKNOWN. On enterprise-class platforms: FAN, POWER SUPPLY, CORE
BLADE (core switch blade), AP BLADE (application processor), SW BLADE (port
blade), CP BLADE (control processor), WWN (WWN card), or UNKNOWN.
Object number
Slot number for blades. Unit number for all other object types.
Event type
Inserted, Removed, or Invalid.
Time of the event
Format: Day Month dd hh:mm:ss yyyy,
The second and third lines of a record contain the factory part number and factory serial number, if
applicable.
Factory Part Number
xx-yyyyyyy-zz or Not available.
Factory Serial Number
xxxxxxxxxxxx or Not available.
The size of the history log depends on the hardware platform. The Brocade DCX supports a maximum
log size of 50 entries. Because the WWNs are completely separate FRUs in the DCX, they have
redundant data in these units. All other platforms that contain FRUs support 28 history log entries.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the late FRU insertion or removal event:
switch:admin> historylastshow
POWER SUPPLY Unit 2
Factory Part Number:
Factory Serial Number:
Records:
SEE ALSO
468
Inserted at Tue Aug 14 15:52:10 2001
60-0001536-02
1013456800
11
historyShow
Fabric OS Command Reference
53-1003108-01
historyMode
2
historyMode
Displays the mode of the field replaceable unit (FRU) history log.
SYNOPSIS
DESCRIPTION
historymode
Use this command to display the mode of the history buffer, which records the insertion and removal of
FRUs on a switch or chassis.
This command supports two modes of handling new log entries once the history buffer has reached its
maximum size:
Rotating mode
Any new entry exceeding the maximum buffer size overwrites the oldest entry in
the log. This is the default mode.
First-in mode
Any new entry exceeding the maximum buffer size is discarded. The original
entries in the buffer is preserved.
The history mode is a factory setting that cannot be modified. The size of the history buffer depends on
the hardware platform. The Brocade DCX backbone supports a maximum log size of 50 entries. Because
the WWNs are completely separate FRUs in the DCX, they have redundant data in these units. All other
platforms containing FRUs support 28 history log entries.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the mode of the history log:
switch:admin> historymode
History Mode is: Rotating.
SEE ALSO
historyLastShow, historyShow
Fabric OS Command Reference
53-1003108-01
469
2
historyShow
historyShow
Displays the entire field replaceable unit (FRU) history log.
SYNOPSIS
DESCRIPTION
historyshow
Use this command to display the entire history log, which records insertion and removal events for
field-replaceable units (FRUs), such as blades, power supplies, fans, and world wide name (WWN)
cards. The type of FRU supported depends on the hardware platform.
Each history record contains three lines of information. The first line of each record contains the
following:
Object type
On standalone platforms: FAN, POWER SUPPLY, WWN (WWN card), or
UNKNOWN.
On enterprise-class platforms: FAN, POWER SUPPLY, CORE BLADE (core
switch blade), SW BLADE (port blade), AP BLADE (application processor), CP
BLADE (control processor), WWN (WWN card), or UNKNOWN.
Object number
Slot number for blades. Unit number for all other object types.
Event type
Inserted, Removed, or Invalid
Time of the event
Format: Day Month dd hh:mm:ss yyyy
The second and third lines of a record contain the factory part number and factory serial number, if
applicable:
Factory Part Number
xx-yyyyyyy-zz or Not available
Factory Serial Number
xxxxxxxxxxxx or Not available
The size of the history buffer depends on the HW platform. The Brocade DCX supports a maximum log
size of 50 entries. Because the WWNs are completely separate FRUs in the DCX, they have redundant
data in these units. All other platforms that contain FRUs support 28 history log entries.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the history log of FRUs and removal events on a standalone switch:
switch:admin> historyshow
470
FAN Unit 3
Factory Part Number:
Factory Serial Number:
Removed at Tue Aug 14 10:05:37 1970
20-123456-12
1013456800
POWER SUPPLY Unit 1
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 10:52:10 1970
60-0001536-02
Not Available
Fabric OS Command Reference
53-1003108-01
historyShow
FAN Unit 3
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 10:23:45 2001
20-123456-12
1013456800
WWN Unit 1
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 11:03:45 2001
40-0000031-03
1013456800
SW BLADE Slot 3
Factory Part Number:
Factory Serial Number:
Removed at Tue Aug 14 12:10:09 2001
60-0001532-03
1013456800
CP BLADE Slot 6
Factory Part Number:
Factory Serial Number:
Removed at Tue Aug 14 13:45:07 2001
60-0001604-02
FP00X600128
SW BLADE Slot 3
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 13:53:40 2001
60-0001532-03
1013456800
CP BLADE Slot 6
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 13:59:50 2001
60-0001604-02
FP00X600128
POWER SUPPLY Unit 2
Factory Part Number:
Factory Serial Number:
Inserted at Tue Aug 14 15:52:10 2001
60-0001536-02
1013456800
Records:
SEE ALSO
2
11
historyLastShow
Fabric OS Command Reference
53-1003108-01
471
2
i
i
Displays a process summary.
SYNOPSIS
DESCRIPTION
i [processID]
Use this command to display information about a specified process or about all processes running on the
local switch. One line is displayed per process. Fields displayed with this command include the
F
Process flags:
ALIGNWARN
001 print alignment warning messages
STARTING
002 being created
EXITING
004 getting shut down
PTRACED
010 set if ptrace (0) has been called
TRACESYS
020 tracing system calls
FORKNOEXEC
040 forked but did not exec
SUPERPRIV
100 used super-user privileges
DUMPCORE
200 dumped core
SIGNALED
400 killed by a signal
S
Process state codes:
D
Uninterruptible sleep (usually IO)
R
Runable (on run queue)
S
Sleeping
T
Traced or stopped
Z
A defunct ("zombie") process
UID
The effective user ID number of the process
PID
The process ID of the process
PPID
The process ID of the parent process
472
Fabric OS Command Reference
53-1003108-01
i
2
C
Processor utilization for scheduling
PRI
Priority number of the process; higher numbers mean lower priority
NI
Nice value used in priority computation
ADDR
Memory address of the process
SZ
The total size of the process in virtual memory, in pages
WCHAN
The address of an event for which a process is sleeping (if blank, process is
running)
TTY
The controlling terminal of the process (? displayed for no controlling terminal)
TIME
The cumulative execution time for the process
CMD
The command name of the process.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
processID
Specifies the process name or process ID for the process to display.
EXAMPLES
To display information about process ID 433:
switch:admin> i 433
F
S UID PID PPID C PRI NI ADDR
000 S 0 433
1 0 69
0
-
SEE ALSO
SZ WCHAN TTY TIME
CMD
1283
5c64 ? 00:00:02 fabricd
diagHelp, routeHelp
Fabric OS Command Reference
53-1003108-01
473
2
iclCfg
iclCfg
Enables or disables Inter-chassis links (ICL).
SYNOPSIS
iclcfg --enable slot/icl_group
iclcfg --disable slot/icl_group
iclcfg --persistentenable slot/icl_group
iclcfg --persistentdisable slot/icl_group
iclcfg --help
DESCRIPTION
NOTES
Use this command to enable or disable an inter-chassis link (ICL) or to enable or disable an ICL
persistently. The command enables or disables the ICL by enabling or disabling the ports associated with
the link. Persistently disabled ports remain disabled across reboots and power cycles. This command is
supported only on the Brocade DCX and the Brocade DCX-S4.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command must be executed on the active CP.
OPERANDS
This command has the following operands:
slot
Specifies the slot number of the ICL group to be enabled or disabled, followed by
a slash (/). The slot on the DCX can be either 5 or 8. On the DCX-4S, valid slots
are 3 and 6.
icl_group
Specifies the ICL port group to be disabled or enabled. An ICL group represents a
range of ports. Specify 0 to enable or disable ports 0 to 15. Specify 1 to enable or
disable ports 16 to 31.
--enable
Enables the ICL for the specified port group.
--disable
Disables the ICL for the specified port group.
--persistentenable
Persistently enables the ICL for the specified port group.
--persistentdisable
Persistently disables the ICL for the specified port group.
--help
Displays the command usage.
EXAMPLES
To disable the ICL for ports 16-31:
switch:user> iclcfg --disable 8/1
To enable the ICL for ports 16-31:
switch:user> iclcfg --enable 8/1
474
Fabric OS Command Reference
53-1003108-01
iclCfg
2
To disable the ICL for ports 16-31 persistently:
switch:user> iclcfg --persistentdisable 8/1
To enable the ICL for ports 16-31 persistently:
switch:user> iclcfg --persistentdnable 8/1
SEE ALSO
None
Fabric OS Command Reference
53-1003108-01
475
2
ifModeSet
ifModeSet
Sets the link operating mode for a network interface.
SYNOPSIS
ifmodeset ["interface"]
ifmodeset interface -an [on | off] -speed [speed] -cap [full | half]
ifmodeset --help
DESCRIPTION
Use this command to set the link operating mode for a network interface.
An operating mode is confirmed with a y or yes at the prompt. If the operating mode selected differs from
the current mode, the change is saved and the command exits.
Changing the link mode is not supported for all network interfaces or for all Ethernet network interfaces.
On the CP of a Brocade DCX or DCX-S4, this command supports eth0 and eth3 as interface
parameters. On all other platforms, only eth0 is supported.
When selecting autonegotiation, you can choose the specific link operating modes that are advertised to
the link partner. At least one common link operating mode must be advertised by both sides of the link.
When forcing the link operating mode, both sides of the link must be forced to the same mode. The link
does not work reliably if one side is set to autonegotiate and the other side is set to forced mode.
Exercise care when using this command. Forcing the link to an operating mode not supported by the
network equipment to which it is attached might result in an inability to communicate with the system
through its Ethernet interface. It is recommended that this command be used only from the serial console
port. When used through an interface other than the serial console port, the command displays a warning
message and prompts for verification before continuing. This warning is not displayed and you are not
prompted when the command is used through the serial console port.
For dual-CP systems, the ifModeSet command affects only the CP you are currently logged in to. To set
the link operating mode on the active CP, you must issue this command on the active CP; to set the link
operating mode on the standby CP, you must issue this command on the standby CP. During failover, the
link operating mode is retained separately for each CP, because the physical links might be set to
operate in different modes.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
"interface"
Specify the name of the interface, optionally enclosed in double quotation marks.
When issued on a Brocade DCX or a DCX-S4 CP, valid interfaces are eth0 and
eth3. On all other platforms, only eth0 is supported.
-an
Configures auto negotiation.
on | off
Sets auto negotiation on or off.
-speed speed
Configures the speed. You can configure 1000, 100, or 10 as the speed. Note that
1000 Mbps speed can be configured only when auto negotiation is on.
-capability
Configures whether the capability of operation is full duplex or half duplex.
476
Fabric OS Command Reference
53-1003108-01
ifModeSet
2
--help
Displays the command usage.
EXAMPLES
To advertise all modes of operation, when not entering this command through the serial console port,
follow this scenario for the ifModeSet command:
switch:admin> ifmodeset eth0
Exercise care when using this command. Forcing the link to
an operating mode not supported by the network equipment to
which it is attached may result in an inability to
communicate with the system through its ethernet interface.
It is recommended that you only use this command from the
serial console port.
Are you sure you really want to do this? (yes, y, no, n): [no] y
Proceed with caution.
Auto-negotiate (yes, y, no, n): [no] y
Advertise 1000 Mbps / Full Duplex (yes, y, no, n): [yes] y
Advertise 100 Mbps / Full Duplex (yes, y, no, n): [yes] y
Advertise 100 Mbps / Half Duplex (yes, y, no, n): [yes] y
Advertise 10 Mbps / Full Duplex (yes, y, no, n): [yes] y
Advertise 10 Mbps / Half Duplex (yes, y, no, n): [yes] y
Committing configuration...done.
To force the link for the eth0 interface from autonegotiation to 10 Mbps half-duplex operation, when
entering this command through the serial console port:
switch:admin> ifmodeset eth0
Auto-negotiate (yes, y, no, n): [yes] n
Force 100 Mbps / Full Duplex (yes, y, no, n): [no] n
Force 100 Mbps / Half Duplex (yes, y, no, n): [no] n
Force 10 Mbps / Full Duplex (yes, y, no, n): [no] n
Force 10 Mbps / Half Duplex (yes, y, no, n): [no] y
Committing configuration...done.
SEE ALSO
ifModeShow
Fabric OS Command Reference
53-1003108-01
477
2
ifModeShow
ifModeShow
Displays the link operating mode and MAC address for a network interface.
SYNOPSIS
DESCRIPTION
ifmodeshow interface
Use this command to display the link operating mode and MAC address for a network interface.
On the CP of a Brocade DCX or DCX-S4, this command supports eth0 and eth3 as interface
parameters. On all other platforms, only eth0 is supported.
The CP on a Brocade DCX or DCX-S4 has two external physical Ethernet management ports, eth1 and
eth3. Both interfaces are bonded together to form a single logical interface, bond0.
The management port IP addresses are assigned to the logical interface, bond0. Link layer Ethernet
operations are applied to the physical interfaces, eth0 and eth3.
Ethernet bonding provides link layer redundancy using the active-standby failover model. The two
Ethernet ports must be part of the same subnet. By default, all traffic is transmitted over the active
Ethernet port, eth0. The second Ethernet port, eth3, acts as a standby interface and no traffic is
transmitted over it. When the active Ethernet port is disconnected, the alternate Ethernet port becomes
active. When the system reboots, the Ethernet port eth0 is always made active if it is connected.
When executed with the bond0 operand, ifModeShow displays the active Ethernet port
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
interface
Specifies the name of the interface, optionally enclosed in double quotation
marks. Valid interfaces include the following:
eth0 | eth3
Displays the link operating mode of the specified interface. The value eth3 is valid
only on the CP of a Brocade DCX or DCX-4S.
bond0
Displays the active Ethernet port. This operand is valid only on the CP of a DCX
or a DCX-S4.
EXAMPLES
To display the link operating mode for the eth0 Ethernet interface:
switch:admin> ifmodeshow eth0
Link mode: negotiated 100baseTx-HD, link ok
MAC Address: 00:60:69:D0:24:40
To display the link operating mode for the eth3 Ethernet interface (in the example, the management port
is disconnected):
switch:admin> ifmodeshow eth3
Link mode: no link
MAC Address: 00:05:1E:40:62:30
478
Fabric OS Command Reference
53-1003108-01
ifModeShow
2
To display the active interface:
ras010:root> ifmodeshow bond0
Currently Active Slave: eth0
SEE ALSO
ifModeSet
Fabric OS Command Reference
53-1003108-01
479
2
iflShow
iflShow
Displays the interfabric link (IFL) information.
SYNOPSIS
iflshow
iflshow --help
DESCRIPTION
Use this command to display the current connection and information of the interfabric links (IFL) on an
edge switch. The command output includes the following information:
E-Port
Port number of the local switch to which FC Router switch is connected
Ex-Port
Port Number of FC Router switch
FCR WWN
WWN of the FC Router switch
FCR FID
Fabric ID of FC Router switch
FCR Name
Switch name of FC Router
Speed
IFL connection speed, if applicable. Connection speed not applicable to
VE_Ports. For these port types, speed displays as '-'.
BW
Bandwidth of the link.
•
•
•
•
•
•
NOTES
OPERANDS
TRUNK - Trunking enabled, if applicable
QOS - QoS enabled, if applicable
ENCRYPT - Encryption enabled, if applicable
COMPRESS - Compression enabled, if applicable
CR_RECOV - Credit recovery enabled, if applicable
FEC - Forward Error Correction enabled, if applicable
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operand:
--help
Displays the command usage.
480
Fabric OS Command Reference
53-1003108-01
iflShow
EXAMPLES
2
To display the interfabric links:
switch:admin> iflshow
EEXFCR WWN
FCR FCR Speed BW
# Port Port
FID Name
---------------------------------------------------------------1: 7-> 8
10:00:00:05:1e:8b:68:10 8 fcr1 4G
4G TRUNK
2: 12-> 13 10:00:00:05:1e:a1:e3:3a 15 fcr2 4G
4G TRUNK
3: 15-> 15 10:00:00:05:1e:a1:e1:f9 12 sw87 4G
4G TRUNK QOS
4: 16-> 16 10:00:50:eb:1a:00:00:02 4 fcr3
4G
SEE ALSO
fcrEdgeShow, fcrFabricShow
Fabric OS Command Reference
53-1003108-01
481
2
interfaceShow
interfaceShow
Displays FSPF interface information.
SYNOPSIS
DESCRIPTION
interfaceshow [slot/][port]
Use this command to display the two data structures associated with FSPF interfaces (E_Ports) on the
switch:
•
•
The permanently allocated interface descriptor block (IDB).
The neighbor data structure. This data structure is allocated when a switch port becomes an E_Port.
The neighbor data structure contains all the information relating to the switch that is connected to an
adjacent switch.
This command displays the content of both data structures, if they have been allocated.
The following fields are displayed:
idbP
Pointer to IDB.
nghbP
Pointer to neighbor data structure.
ifNo
Interface number.
masterPort
Port number of the trunk master port, if present, of the trunk group of which this
port is a part.
prgm_if_id
Internal variable
curr_if_id
Internal variable
prgmCnt
Number of remote domains the link has been programmed to reach for routing
traffic.
defaultCost
Default cost of sending a frame over the interswitch link (ISL) connection to this
interface.
cost
Cost of sending a frame over the ISL connected to this interface. A value of 1000
indicates a 1-Gbps link. A value of 500 indicates a 2-Gbps link. For links with a
bandwidth greater than 2 Gbps, the cost is 500. For links with less than 1 Gbps,
the cost is 2000. Refer to linkCost for more information.
ifBw
The rounded bandwidth of the interface, in Gbps.
totalBw
The summed total bandwidth for the entire trunk and ISL, in Gbps.
delay
Conventional delay incurred by a frame transmitted on this ISL. A fixed value
required by the FSPF protocol.
lastScn
Type of the last State Change Notification received on this interface.
482
Fabric OS Command Reference
53-1003108-01
interfaceShow
2
lastScnTime
Time the last State Change Notification was received on this interface.
upCount
Number of times this interface came up, with respect to FSPF.
lastUpTime
Last time this interface came up.
downCount
Number of times this interface went down.
lastDownTime
Last time this interface went down.
downReason
Type of last State Change Notification that caused this interface to go down.
iState
Current state of this interface. The state can be UP or DOWN. An interface in
DOWN state does not have an allocated neighbor data structure and cannot be
used to route traffic to other switches.
state
Current state of this interface. This E_Port is used to route traffic to other switches
only if the state is NB_ST_FULL.
lastTransition
Time the last state changed on this interface.
nghbCap
Neighbor capabilities. Should be 0.
nghbId
Domain ID of the neighbor (adjacent) switch.
idbNo
IDB number. Should be equal to port.
remPort
Port number on the remote switch connected to this port.
nflags
Internal FSPF flags.
initCount
Number of times this neighbor was initialized without the interface going down.
lastInit
Time of the last initializing state, NB_ST_INIT, on this interface.
firstHlo
Time of the first hello sent on this interface.
nbstFull
Time of the last finishing state, NB_ST_FULL, on this interface.
&dbRetransList
Pointer to the database retransmission list.
&lsrRetransList
Pointer to the link state records (LSR) retransmission list.
&lsrAckList
Pointer to the link state acknowledgements (LSA) retransmission list.
inactTID
Inactivity timer ID.
Fabric OS Command Reference
53-1003108-01
483
2
interfaceShow
helloTID
Hello timer ID.
dbRtxTID
Database retransmission timer ID.
lsrRtxTID
LSR retransmission timer ID.
inactTo
Inactivity timeout value, in milliseconds. When this timeout expires, the adjacency
with the neighbor switch is broken and new paths are computed to all possible
destination switches in the fabric.
helloTo
Hello timeout value, in milliseconds. When this timeout expires, a Hello frame is
sent to the neighbor switch through this port.
rXmitTo
Retransmission timeout value, in milliseconds. It is used to transmit topology
information to the neighbor switch. If no acknowledgement is received within this
value, the frame is retransmitted.
nCmdAcc
Total number of commands accepted from the neighbor switch. Number includes
Hellos, Link State Updates (LSUs), and LSAs.
nInvCmd
Number of invalid commands received from the neighbor switch. Usually
commands with an FSPF version number higher than the one running on the local
switch.
nHloIn
Number of Hello frames received from the neighbor switch.
nInvHlo
Number of invalid Hello frames (Hello frames with invalid parameters) received
from the neighbor switch.
nLsuIn
Number of LSUs received from the neighbor switch.
nLsaIn
Number of LSAs received from the neighbor switch.
attHloOut
Number of attempted transmissions of Hello frames to the neighbor switch.
nHloOut
Number of Hello frames transmitted to the neighbor switch.
attLsuOut
Number of attempted transmissions of LSUs to the neighbor switch.
nLsuOut
Number of LSUs transmitted to the neighbor switch.
attLsaOut
Number of attempted transmissions of LSAs to the neighbor switch.
nLsaOut
Number of LSAs transmitted to the neighbor switch.
StuckCnt
Number of HLO timeouts that occurred before the port changed to the
NB_ST_FULL state.
484
Fabric OS Command Reference
53-1003108-01
interfaceShow
2
state
Substate of the port. The port can be in one of the following 12 substates:
INIT (0)
The port is initializing.
ROUTABLE (1)
The port is ready to receive frames.
ROUTABLE_WAIT (2)
The port is waiting for notification from the neighbor.
ROUTABLE_SEND (3)
The port is preparing for local route update; negotiates for the necessary locks
before updating the routes.
ROUTABLE_TIMER (4)
The request for one or more locks failed; delay for a short interval before retrying.
DONE (5)
The port is online and in use.
DECOM_START (6)
The decommissioning request is sent to the neighbor and waiting for a response.
DECOM_WAIT (7)
Waiting for neighbor to remove routes using the interswitch link (ISL).
DECOM_SEND (8)
Preparing to update routes of the local port; negotiates for the necessary before
updating the routes.
DECOM_TIMER (9)
The request for one or more locks failed; delay for a short interval before retrying.
DECOM_DONE (10)
The local routes are updated; waiting for acknowledgement from the neighbor.
DECOM_BLOCK (11)
The local routes are updated; the neighbor sent acknowledgement.
chassis_lock
Internal variable
lock_request
Internal variable
nbr_lock_lock
Internal variable
r_rdy_rcvd
Indicates if the neighbor has reported as ready to receive frames.
nbr r_rdy flags
Internal flags reported by the neighbor.
lock_busy_cnt
Number of times a lock has reported as busy.
decom_active
Indicates if a decommissioning request is active on the port.
decom_initiator
Indicates if the local port is the decommissioning request initiator.
decom_active_port
Indicates the port for which the decommissioning request is active.
Fabric OS Command Reference
53-1003108-01
485
2
interfaceShow
decom_trunk_member
Indicates if decommissioning request is for a multi-link trunk.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
slot
For bladed systems only, specify the slot number of the port to be displayed,
followed by a slash (/).
port
Specify the number of the port to be displayed, relative to its slot for bladed
systems. Use switchShow for a list of valid ports. This operand is optional; if
omitted, the interface information for all ports is displayed.
When invoked without operands, this command displays the interface information for all ports on the
switch (including non-E_Ports).
EXAMPLES
To display FSPF interface information:
switch:user> interfaceshow 1/19
idbP
= 0x102651a0
Interface 131 data structure:
nghbP
ifNo
masterPort
prgm_if_id
curr_if_id
prgmCnt
defaultCost
cost
ifBw
totalBw
delay
lastScn
lastScnTime
upCount
lastUpTime
downCount
lastDownTime
downReason
iState
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
0x10b968f0
131
131
0x43120021
0x43120021
1
500
500
8G
24G
1
0
Jan 01 00:00:00.000
0
Jan 01 00:00:00.000
0
Jan 01 00:00:00.000
0
UP
Neighbor 131 data structure:
state
lastTransition
nghbCap
nghbId
idbNo
remPort
nflags
initCount
lastInit
firstHlo
486
=
=
=
=
=
=
=
=
=
=
NB_ST_FULL
Jun 04 05:05:02.592
0x0
188
131
243
0xf
0
Jun 04 05:05:02.592
Jun 04 05:05:21.474
Fabric OS Command Reference
53-1003108-01
interfaceShow
nbstFull
&dbRetransList
&lsrRetransList
&lsrAckList
inactTID
helloTID
dbRtxTID
lsrRtxTID
inactTo
helloTo
rXmitTo
nCmdAcc
nInvCmd
nHloIn
nInvHlo
nLsuIn
nLsaIn
attHloOut
nHloOut
attLsuOut
nLsuOut
attLsaOut
nLsaOut
StuckCnt
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
2
Jan 01 00:00:00.000
0x10b96928
0x10b96930
0x10b96938
0x10b96b08
0x10b97cb8
0x10b98e68
0x10b9b1c8
160000
20000
5000
38
0
35
0
2
1
35
35
1
1
2
2
0
Port Sub-State Data:
state
= DONE (5)
chassis_lock
= 0
lock_request
= 0
nbr_lock_lock
= 0
r_rdy_rcvd
= 0
nbr r_rdy flags = 0x0
lock_busy_cnt
= 0
decom_active
= 0
decom_initiator = 0
decom_active_port = -1
decom_trunk_member = 0
SEE ALSO
nbrStateShow, portShow, switchShow
Fabric OS Command Reference
53-1003108-01
487
2
iodReset
iodReset
Disables in-order delivery (IOD) on a switch.
SYNOPSIS
DESCRIPTION
iodreset
Use this command to disable in-order delivery enforcement on the local switch. IOD is disabled by
default, and can only be disabled after it has been enabled with the iodSet command. This command
disables the legacy IOD enforcement only.
Disabling IOD allows faster rerouting after a fabric topology change, but it may cause out-of-order
delivery of frames during fabric topology changes.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To disable IOD enforcement:
switch:admin> iodreset
IOD is not set
SEE ALSO
488
iodSet, iodShow
Fabric OS Command Reference
53-1003108-01
iodSet
2
iodSet
Enables in-order delivery (IOD).
SYNOPSIS
iodset
iodset --help
DESCRIPTION
Use this command to enforce in-order delivery of frames during a fabric topology change.
In a stable fabric, frames are always delivered in order, even when the traffic between switches is shared
among multiple paths. However, when topology changes occur in the fabric (for instance, a link goes
down), traffic is rerouted around the failure and some frames might be delivered out of order. This
command ensures that frames are not delivered out-of-order, even during fabric topology changes. It
enforces a sufficient delay between the event that causes an existing path to be removed and the
establishment of a new path, so that frames are delivered in order. However, this also means that frames
are dropped during the delay, causing I/O failures.
When used without operands, iodSet enables in-order-delivery of frames on a switch (legacy IOD
behavior). Frame loss is unavoidable when a port goes down.
IOD is disabled by default. Use iodShow to display current settings. Use iodReSet to restore the default
setting.
NOTES
You can no longer use this command to manage Lossless DLS. Use dlsSet instead. The following
command options are deprecated in Fabric OS v6.4.0 and later:
•
•
•
iodset --enable -lossLessDls
iodset --disable -lossLessDls
iodset --show
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
This command has the following operands:
--help
Displays the command usage.
EXAMPLES
To display the default legacy IOD setting:
switch:admin> iodshow
IOD is not set
To enable IOD:
switch:admin> iodset
IOD is set
SEE ALSO
iodShow, iodReset
Fabric OS Command Reference
53-1003108-01
489
2
iodShow
iodShow
Displays the in-order delivery (IOD) setting.
SYNOPSIS
DESCRIPTION
NOTES
iodshow
Use this command to display the IOD setting on the switch. By default, IOD is disabled.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
OPERANDS
None
EXAMPLES
To display the current setting of the IOD setting:
switch:admin> iodshow
IOD is not set
SEE ALSO
490
iodReset, iodSet
Fabric OS Command Reference
53-1003108-01
ipAddrSet
2
ipAddrSet
Sets the Ethernet and FC IP addresses.
SYNOPSIS
ipaddrset [-ipv6 ] [--add x:x:x:x:x:x:x/n | --delete]
ipaddrset [-cp cp_number | -chassis]
[-ipv6 ] [--add x:x:x:x:x:x:x/n | --delete]
ipaddrset [-slot slot] [-eth0 | -eth1] [--add x.x.x.x/n | --delete]
ipaddrset [-slot slot] -gate [--add x.x.x.x | --delete]
ipaddrset -ls FID --add IPv4_address/prefix
ipaddrset -ls FID --delete
ipaddrset -ipv6 [-auto | -noauto]
ipaddrset [-cp cp_number | -chassis]
ipaddrset -cp cp_number -ipv4 -add -host hostname
-ethip ipaddress -ethmask mask
-gwyip gateway_ip
ipaddrset -ipv4 -add -ethip ipaddress -ethmask mask
-gwyip gateway_ip -dhcp [ON | OFF]
ipaddrset -chassis -ipv4 -add
-ethip ipaddress -ethmask mask
ipaddrset -ipv6 [-dhcpv6 | -nodhcpv6]
ipaddrset --clear
ipaddrset --help
DESCRIPTION
Use this command to configure the IP addresses on a switch, a control processor (CP), a blade
processor (BP), or a standalone application processor (AP). On platforms that support Logical Fabrics,
this command configures the IPv4 Fibre Channel addresses for the logical fabric IPFC network interface.
The IPFC (IP over Fibre Channel) protocol allows switches to send IP traffic over Fibre Channel rather
than through Ethernet connections.
This command supports an interactive legacy mode and a command line interface. Use the command
line interface to configure IPv6 addresses, to enable or disable stateless IPv6 autoconfiguration, to
assign a Fibre Channel IPv4 address and prefix to a logical switch IPFC network interface, and to
configure a service port on the CP blade of a Brocade DCX. When run interactively in legacy mode, this
command sets the Ethernet IPv4 address, subnet mask, and Gateway on a switch or a chassis.
Command usage depends on the type of IP address and on the platform on which the command is run.
Some of the platform- and IP address-specific features of the command are outlined below. For complete
details, refer to the Fabric OS Administrator's Guide.
Configuring IP Addresses using the command line interface
Fabric OS Command Reference
53-1003108-01
491
2
ipAddrSet
•
•
•
The command accepts the -ipv6 command line syntax with the --add or --delete option on all
platforms that support IPv6 addresses. The --add option configures a single static IPv6 address and
prefix for the specified managed entity (chassis, CP, or AP). The --delete option deletes a static IPv6
address and prefix for the specified managed entity. On modular platforms, the command can be
executed only on the active CP.
-
When using the command line syntax to add or delete IPv6 addresses, the managed entity is
identified only on modular platforms. To set the CP IPv6 address, use the -cpoption; to set the
IP address for the entire chassis, use the -chassis option.
-
When using the command line syntax to add or delete IPv6 addresses on standalone platforms,
the implied entity is the single managed entity supported by the platform and must be left
unspecified.
-
Additionally, the -eth0, -eth1, and -gate command line options are available with the --add or
--delete option on platforms with blade processors to set the BP Ethernet or Gateway
addresses. On a chassis with a blade processor the values for the blade in can be set from the
command line using the -slot option. The -slot option is not accepted in standalone application
processors with a hidden blade, such as the AP7600.
Use the -auto and -noauto options to enable or disable stateless IPv6 autoconfiguration.
Use the -ls option with appropriate arguments to set or delete the IPv4 Fibre Channel address and
prefix for the IPFC interface of a logical switch. In a Virtual Fabric environment, each logical fabric is
represented by a separate IPFC network interface. Each of these network interfaces can be
assigned a unique IPv4 FC address and prefix. The logical switches that make up a logical fabric are
identified by the fabric ID (FID) that is assigned to each of the logical switch instances.
When setting the IPFC interface of a switch that is not in Virtual Fabric mode, use the -ls option with
FID 128. FID 128 identifies the switch when Virtual Fabrics are disabled.
Setting IP addresses interactively (IPv4 Ethernet address only):
NOTES
OPERANDS
•
To set the CP Ethernet IPv4 address, use the -cp option; to set the Ethernet IP address for the entire
chassis, use the -chassis option. When setting the chassis IP address, the command prompts for
the Ethernet IP address and Ethernet subnet mask. When setting the CP Ethernet IP address, the
command prompts for the host name, Ethernet IP address, Ethernet subnet mask, and Gateway IP
address. Valid switch and CP numbers depend on the platform on which the command is run. The
command must be executed on the active CP.
•
On most standalone platforms (with the exception of the AP7600), ipAddrSet runs interactively if
invoked without operands. The command prompts for the Ethernet IP address, Ethernet subnet
mask, and Gateway IP address. In addition, the command prompts for a specification of whether the
Dynamic Host Control Protocol (DHCP) should be used to acquire the Ethernet IP address, Ethernet
subnet mask and Gateway IP address. Valid entries are "On" to enable DHCP and "Off" to disable it.
When DHCP is enabled, any user-configured Ethernet IP address, Ethernet subnet mask or
Gateway IP address is ignored.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
When used in command line mode, the following operands are supported:
-Ipv6
Specifies IP address type as static IPv6 including prefix as needed.
--add x:x:x:x:x:x:x/n
Sets the specified IPv6 address.
--delete [x:x:x:x:x:x:x/n]
Deletes the specified IPv6 address. If no address is specified, any existing IPv6
addresses and prefixes are deleted from the specified or implied entity.
492
Fabric OS Command Reference
53-1003108-01
ipAddrSet
2
-cp cp_number
Specifies the CP on a chassis. Valid values are 0 or 1.
-chassis
Specifies the IPv6 address and prefix of a chassis.
On platforms with blade processors, the following additional command line
options are supported with the --add or --delete options:
-eth0 | -eth1
Specifies the local IPv4 address of the blade processor. A prefix is required.
-gate
Specifies the IPv4 address of the blade processor (BP) Gateway (no prefix).
-slot number
On a chassis with a blade processor (BP), specifies the slot number. On
standalone platforms with a hidden BP, such as the AP76500, this parameter is
not accepted.
-ipv6 [-auto | -noauto]
Enables or disables stateless IPv6 autoconfiguration on a switch or chassis.
When autoconfiguration is enabled, the host automatically performs configuration
of IPv6 addresses and periodic nondisruptive reconfiguration. By default,
autoconfiguration is disabled.
-ls FID
Specifies the logical fabric ID for which to configure an IPFC network interface.
The FID is a decimal number. A switch that is not in Virtual Fabric mode uses the
-ls parameter with FID 128 (the effective, single Logical Fabric number on such
switches) to set the IPv4 FC address. Note that setting the IP address for the
logical switch is only for the IPFC interface, not for the Ethernet interface.
--add
Assigns a specified IPv4 FC address and prefix to the logical switch instance
represented by the specified FID. This command replaces any existing FC
IPv4 address.
IPv4_address/prefix
Specifies the IPv4 address and prefix for the IPFC network interface. The IP
Address is represented by a dotted decimal number, followed by a slash and
a prefix. This operand is required with the --add option.
--delete
Deletes the IPv4 FC address and prefix from a logical switch.
-ls IFID
Specifies the fabric ID that identifies the logical switch for which to delete the
FC IPv4 address and prefix. This operand is required when deleting an FC
IPv4 address from a logical switch. On a switch that is not in Virtual Fabric
mode, use the -ls parameter with FID 128 (the effective, single Logical Fabric
number on such switches) to delete the IPv4 FC address.
When used interactively to configure IPv4 addresses on a modular platform, ipAddrSet prompts for the
following parameters:
-cp cp_number
Specifies the managed entity as a CP. Valid values include the following:
0
Sets the Ethernet IP address, Ethernet subnet mask, gateway IP address and
host name of CP0.
Fabric OS Command Reference
53-1003108-01
493
2
ipAddrSet
1
Sets the Ethernet IP address, Ethernet subnet mask, gateway IP address and
host name of CP1.
-chassis
Specifies the managed entity as the chassis.
-ipv4
Specifies IP address type as static IPv4.
-add
Sets the specified IPv4 address.
-host hostname
Sets the hostname.
-ethip ipaddress
Sets the ethernet IP address.
-ethmask mask
Sets the ethernet mask.
-gwyip gateway_ip
Sets the gateway IP address.
-dhcp[ON | OFF]
Enables or disables DHCP.
-dhcpv6
Enables DHCPv6.
-nodhcpv6
Disables DHCPv6.
--clear
Clears all IP (IPv4 and IPv6) addresses on a management interface.
--help
Displays command usage.
EXAMPLES
To configure an IPv6 address and prefix on a standalone platform:
switch:admin> ipaddrset -ipv6 --add \
fec0:60:69bc:60:260:69ff:fed0:107/64
To configure an IPv6 address and prefix on a single CP of a chassis:
switch:admin> ipaddrset -cp 0 -ipv6 --add
1080::8:800:200C:417A/64
\
To delete any existing IPv6 address and prefix on CP0 on an enterprise-class platform:
switch:admin> ipaddrset cp 0 -ipv6 --delete
To configure an IPv4 FC address for the IPFC interface associated with a logical switch with fabric ID
123:
switch:admin> ipaddrset -ls 123 --add 11.1.2.4/24
IP address is being changed...Done.
494
Fabric OS Command Reference
53-1003108-01
ipAddrSet
2
To verify the IPv4 FC address for the logical switch:
switch:admin> ipaddrshow
CHASSIS
Ethernet IP Address: 10.32.220.10
Ethernet Subnetmask: 255.255.240.0
CP0
Ethernet IP Address: 10.32.220.11
Ethernet Subnetmask: 255.255.240.0
Host Name: cp0
Gateway IP Address: 10.32.208.1
CP1
Ethernet IP Address: 10.32.220.12
Ethernet Subnetmask: 255.255.240.0
Host Name: cp1
Gateway IP Address: 10.32.208.1
IPFC address for logical fabric ID 128: 1.2.3.4/24
Backplane IP address of CP0 : 10.0.0.5
Backplane IP address of CP1 : 10.0.0.6
To delete the IPv4 address for the IPFC interface associated with a logical switch with Virtual Fabric ID
67:
switch:admin> ipaddrset -ls 67 --delete
IP address is being changed...Done.
To configure an IPv4 FC address for the IPFC interface associated with a switch that is not in Virtual
Fabric mode:
switch:admin> ipaddrset -ls 128 --add 10.32.72.70/24
IP address is being changed...Done.
To verify the changes:
switch:admin> ipaddrshow
SWITCH
Ethernet IP Address: 10.32.72.9
Ethernet Subnetmask: 255.255.240.0
Gateway IP Address: 10.32.64.1
DHCP: Off
IPFC address for virtual fabric ID 128: 10.32.72.70/24
To set the IPv4 address details for a switch chassis in interactive mode:
switch:admin> ipaddrset -chassis
Ethernet IP Address [192.168.166.148]:
Ethernet Subnetmask [255.255.255.0]:
Committing configuration...Done.
To enable DHCP on a standalone, non-AP platform:
switch:admin> ipaddrset
Ethernet IP Address [192.168.74.102]:
Ethernet Subnetmask [255.255.255.0]:
Gateway IP Address [192.168.74.1]:
DHCP [Off]: on
Fabric OS Command Reference
53-1003108-01
495
2
ipAddrSet
To enable DHCPv6 on a device:
switch:admin> ipaddrset -ipv6 -dhcpv6
To clear all IP address information on a management interface and verify the changes:
switch:admin> ipaddrset --clear
Warning: All management interface will be closed, \
which will result in all network connections \
being terminated.
Please initiate a connection to the serial console of \
the switch to configure the management interface.
Would you like to continue with clearing the IP \
configuration?(y/n)y
switch:admin> ipaddrshow
CHASSIS
Ethernet IP Address: none
Ethernet Subnetmask: none
CP0
Ethernet IP Address: none
Ethernet Subnetmask: none
Host Name: cp0
Gateway IP Address: none
CP1
Ethernet IP Address: none
Ethernet Subnetmask: none
Host Name: cp1
Gateway IP Address: none
SEE ALSO
496
ipAddrShow
Fabric OS Command Reference
53-1003108-01
ipAddrShow
2
ipAddrShow
Displays IP address information for a switch or control processor (CP).
SYNOPSIS
ipaddrshow
ipaddrshow [-cp cp_number] | -chassis
ipaddrshow -slot slot [-eth0 | -eth1 | -gate
DESCRIPTION
Use this command to display the IP addresses configured in the system.
The -cp option displays the IP address for a specified CP on modular platforms, or use the command
without arguments to display the IP address on a standalone switch, or the IP addresses for both CPs on
a chassis.
On a standalone switch, the command displays the following information:
•
•
•
•
•
•
•
•
Ethernet IP Address
Ethernet Subnet mask
The Gateway IP Address
Dynamic Host Control Protocol (DHCP): on or Off
IPv6 Autoconfiguration Enabled: Yes or No
Local IPv6 Addresses
IPv6 Gateway address
DHCPv6: on or off
On modular platforms, the command displays the following information:
For the chassis:
•
•
Ethernet IP Address
Ethernet Subnet mask
For each CP:
•
•
•
•
Ethernet IP Address
Ethernet Subnet mask
Host Name
Gateway IP Address
If the IPFC network interface is configured for logical switches:
•
IPFC address for Virtual Fabric ID
For each CP:
-
Backplane IP address
IPv6 Autoconfiguration Enabled: Yes or No. If enabled, the command displays:

All local IPv6 Addresses

Gateway IP addresses for both CPs
Local IPv6 addresses display the following identifiers:
•
IP Address type:
•
static - A statically configured IPv6 address.
stateless - Acquired through stateless autoconfiguration.
IP Address state:
Fabric OS Command Reference
53-1003108-01
497
2
ipAddrShow
-
tentative
preferred
deprecated
Refer to the RFC 2462 specification for more information.
On modular platforms with intelligent blades, the addresses configured for each slot can be shown with
the -slot option. On standalone platforms, all command options are ignored.
NOTES
OPERANDS
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command has the following operands:
-cp cp_number
On dual-CP systems, specifies the CP card number to be displayed (0 or 1).
-chassis
On dual-CP systems, displays the IP addresses for the chassis.
-slot slot
Specifies the slot for a blade.
-eth0 | -eth1 | -gate
For a specified slot, shows only the selected Ethernet interface or the gateway .
This operand is optional with the -slot option.
EXAMPLES
To display the IP addresses on a standalone switch:
switch:admin> ipaddrshow
SWITCH
Ethernet IP Address: 10.20.21.204
Ethernet Subnetmask: 255.255.240.0
Gateway IP Address: 10.20.16.1
DHCP: Off
IPv6 Autoconfiguration Enabled: Yes
Local IPv6 Addresses:
dhcpv6 fd00:60:69bc:82:a6f3:568b:a9cc:a149/64 preferred
stateless fd00:60:69bc:82:205:33ff:fe94:771f/64 preferred
IPv6 Gateways:
fe80::21b:edff:fe0b:2400
fe80::21b:edff:fe0b:7800
DHCPv6: On
To display all IP addresses on a Brocade DCX backbone:
switch:admin> ipaddrshow
Chassis
Ethernet IP Address: 10.33.60.85
Ethernet Subnetmask: 255.255.240.0
CP0
Ethernet IP Address: 10.33.60.86
Ethernet Subnetmask: 255.255.240.0
Host Name: cp0
Gateway IP Address: 10.33.48.1
CP1
Ethernet IP Address: 10.33.60.87
498
Fabric OS Command Reference
53-1003108-01
ipAddrShow
2
Ethernet Subnetmask: 255.255.240.0
Host Name: cp1
Gateway IP Address: 10.33.48.1
Backplane IP address of CP0 : 10.0.0.5
Backplane IP address of CP1 : 10.0.0.6
IPv6 Autoconfiguration Enabled: Yes
Local IPv6 Addresses:
chassis 0 stateless fd00:60:69bc:63:205:1eff:fe39:e45a/64 preferred
chassis 0 stateless fec0:60:69bc:63:205:1eff:fe39:e45a/64 preferred
cp 0 stateless fd00:60:69bc:63:205:1eff:fe40:6230/64 preferred
cp 0 stateless fec0:60:69bc:63:205:1eff:fe40:6230/64 preferred
cp 1 stateless fd00:60:69bc:63:205:1eff:fe39:ff2a/64 preferred
cp 1 stateless fec0:60:69bc:63:205:1eff:fe39:ff2a/64 preferred
IPv6 Gateways:
cp 0 fe80:60:69bc:63::3
cp 0 fe80:60:69bc:63::1
cp 0 fe80:60:69bc:63::2
cp 1 fe80:60:69bc:63::1
cp 1 fe80:60:69bc:63::2
cp 1 fe80:60:69bc:63::3
To display the IP addresses for a chassis:
switch:admin> ipaddrshow -chassis
CHASSIS
Ethernet IP Address: 10.32.220.10
Ethernet Subnetmask: 255.255.240.0
IPv6 Autoconfiguration Enabled: Yes
Local IPv6 Addresses:
chassis 0 stateless fd00:60:69bc:63:205:1eff:fe39:e45a/64 preferred
chassis 0 stateless fec0:60:69bc:63:205:1eff:fe39:e45a/64 preferred
IPv6 Gateways:
To display only the IP addresses for CP 1:
switch:admin> ipaddrshow
CP1
Ethernet IP Address: 10.33.60.87
Ethernet Subnetmask: 255.255.240.0
Host Name: cp1
Gateway IP Address: 10.33.48.1
SEE ALSO
ipAddrSet
Fabric OS Command Reference
53-1003108-01
499
2
ipFilter
ipFilter
Manages the IP filter policies.
SYNOPSIS
ipfilter --create policyname -type ipv4 | ipv6
ipfilter --clone policyname -from src_policyname
ipfilter --show [-a] [policyname]
ipfilter --save [policyname]
ipfilter --activate policyname
ipfilter --delete policyname
ipfilter --addrule policyname -rule rule_number[ -sip source_IP]
-dp destination_port -proto protocol -act permit | deny
[-type INPUT | FWD] [-dip destination_IP]
ipfilter --delrule policyname -rule rule number
ipfilter --transabort
ipfilter --clrcounters
ipfilter --showcounters
DESCRIPTION
Use this command to manage IP filter policies. The ipFilter command and command options are
noninteractive, except when prompting for a confirmation.
The IP filter policy sets up a packet filtering firewall to provide access control on the management IP
interface. The IPv4 and IPv6 policies are either in the defined configuration or in the active configuration.
Excluding the default policies, there can be a maximum of six policies in the defined configuration and
one policy per IPv4 and IPv6 type in the active configuration.
The active policy must be the default policy or one of the policies in the defined configuration. Only the
active policies are enforced. All of the ipFilter options except --show and --transabort, create a
transaction owned by the management session initiating the commands.
An open transaction prevents other transactions from being created on different management sessions.
The --create, --clone, --delete, --addrule, and --delrule operands modify policies in memory buffer,
while operands, --save and --activate commit policies to the persistent configuration. The operands,
--save and --activate, implicitly end the transaction if all policy changes are committed. The operand
--transabort explicitly ends an open transaction and aborts policy changes in memory buffer. Closing the
management session that owns the transaction also aborts policy changes and closes the transaction.
NOTES
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
In a Virtual Fabric environment, IP Filter policies are treated as chassis-wide configurations and apply to
all logical switches in the chassis. Chassis permissions are required to manage IP Filter policies.
500
Fabric OS Command Reference
53-1003108-01
ipFilter
OPERANDS
2
This command has the following operands:
policyname
Specifies an IP filter policy name. The policy name is a unique string composed of
a maximum of 20 alphanumeric or underscore characters. The default_ipv4 and
default_ipv6 names are reserved for default IP filter policies. The policy name is
case-insensitive and is always stored as lower case. The policy type identifies the
policy as an IPv4 or IPv6 filter. You can create a maximum of eight IP filter
policies.
--create policyname -type ipv4 | ipv6
Creates an IP filter policy with the specified name and type. The policy created is
stored in a temporary buffer and is lost if the policy is not saved to the persistent
configuration.
--clone policyname -from src_policyname
Creates a replica of an existing IP filter policy. The cloned policy is stored in a
temporary buffer and has the same rules as the original policy.
--show [-a] [policyname]
Displays the IP filter policy content for the specified policy name or all IP filter
policies if policyname is not specified. For each IP filter policy, the policy name,
type, persistent state, and policy rules are displayed. The policy rules are listed by
the rule number in ascending order. The -a option displays the traffic type and the
configured destination IP.
Command output displays without pagination. Use command | more to display the
output with page breaks. If a temporary buffer exists for an IP filter policy, the
--show operand displays the content in the temporary buffer, with the persistent
state set to modified defined or modified active.
--save [policyname]
Saves one or all IP filter policies persistently as the defined configuration. This
operand is optional. If a policy name is specified, only the specified IP filter policy
in the temporary buffer is saved; otherwise, all IP filter policies in the temporary
buffer is saved. Only the CLI session that owns the updated temporary buffer can
run this command. Modification to an active policy cannot be saved without being
applied. Therefore, the --save option is blocked for the active policies; instead use
the --activate option.
--activate policyname
Activates the specified IP filter policy. IP filter policies are not enforced until they
are activated. Only one IP filter policy per IPv4 and IPv6 type can be active. If
there is a temporary buffer for the policy, the policy is saved to the defined
configuration and activated at the same time. If there is no temporary buffer for the
policy, the policy existing in the defined configuration becomes active. The policy
to be activated replaces the existing active policy of the same type. Activating the
default IP filter policies returns the IP management interface to its default state. An
IP filter policy without any rule cannot be activated. This operand prompts for
confirmation before proceeding.
--delete policyname
Deletes the specified IP filter policy. Deleting an IP filter policy removes it from the
temporary buffer. To permanently delete the policy from the persistent database,
issue the ipfilter --save command. An active IP filter policy cannot be deleted.
--addrule policyname
Adds a new rule to the specified IP filter policy. The change made to the specified
IP filter policy is not saved to the persistent configuration until saved or activated.
Fabric OS Command Reference
53-1003108-01
501
2
ipFilter
The following arguments are supported with the --addrule option:
-sip source_IP
Specifies the source IP address. For filters of type IPv4, the address must be a
32-bit address in dot notation, or a CIDR-style IPv4 prefix. For filters of type IPv6,
the address must be a 12- bit IPv6 address in any format specified by RFC3513,
or a CIDR-style IPv6 prefix. The source IP option is not supported for FORWARD
traffic
-dp destination_port
Specifies the destination port number, a range of port numbers, or a service
name. Note that blocking or permitting of ports 1024 and above is not allowed.
These ports are used by various applications and services on the switch.
-proto protocol
Specifies the protocol type, for example, tcp or udp.
-act permit | deny
Specifies the permit or deny action associated with this rule. Blocking or permitting
port 1024 and above is not allowed. Ports numbered 1024 and higher are used by
applications for services such as FTP and blocking these ports may cause these
applications to behave in unexpected ways. Blocking or permitting the RPC ports
111, 897, and 898 is not allowed.
rule rule_number
Adds a new rule at the specified rule index number. The rule number must be
between 1 and the current maximum rule number plus one.
-type INPUT | FWD
Specifies the type of traffic that is allowed for the specified IP address.
Forwarding rules manage the bidirectional traffic between the external Ethernet
interface (eth0/bond0) and the inband management interface (inbd+). INPUT
traffic is the default type of traffic for IP filter rules.
-dip destination_IP
Specifies the destination IP address. For filters of type IPV4, the address must be
a 32-bit address in dot notation, or a CIDR-style IPv4 prefix. For filters of type
IPv6, the address must be in a 128-bit IPv6 address in any format specified by
RFC3513, or a CIDR-style IPv6 prefix. The destination IP option is not be
supported for INPUT traffic type.
--delrule policyname -rule rule_number
Deletes a rule from the specified IP filter policy. Deleting a rule in the specified IP
filter policy causes the rules following the deleted rule to shift up in rule order. The
change to the specified IP filter policy is not saved to the persistent configuration
until it is saved or activated.
--transabort
A transaction is associated with a CLI or manageability session, which is opened
implicitly when you execute the --create, --addrule and --delrule subcommands.
The --transabort command explicitly ends the transaction owned by the current
CLI or manageability session. If a transaction is not ended, other CLI or
manageability sessions are blocked on the subcommands that would open a new
transaction.
--clrcounters
Clears the IP filter counters. This command requires root permissions.
--showcounters
Displays the IP filter counters. This command requires root permissions.
502
Fabric OS Command Reference
53-1003108-01
ipFilter
EXAMPLES
2
To create an IP filter for a policy with an IPv6 address:
switch:admin> ipfilter --create ex1 -type ipv6
To add a new rule to the policy and specify the source IP address, destination port, and protocol, and to
permit the rule:
switch:admin> ipfilter --addrule ex1 \
-sip fec0:60:69bc:60:260:69ff:fe80:d4a -dp 23
-proto tcp -act permit
\
To display all existing IP filter policies:
switch:admin> ipfilter --show
Name:
Rule
1
2
3
4
5
6
7
8
default_ipv4, Type: ipv4,
Source IP
Protocol
any
tcp
any
tcp
any
tcp
any
tcp
any
udp
any
udp
any
tcp
any
udp
State: active
Dest Port
Action
22
permit
23
permit
80
permit
443
permit
161
permit
123
permit
600 - 1023
permit
600 - 1023
permit
Name:
Rule
1
2
3
4
5
6
7
8
default_ipv6,
Source IP
any
any
any
any
any
any
any
any
State: active
Dest Port
Action
22
permit
23
permit
80
permit
443
permit
161
permit
123
permit
600 - 1023 permit
600 - 1023 permit
Type: ipv6,
Protocol
tcp
tcp
tcp
tcp
udp
udp
tcp
udp
To activate the IP Filter policy "ex1":
switch:admin> ipfilter --activate ex1
To display al l IP Filter policies, including the activated policy:
switch:admin> ipfilter --show
Name:
Rule
1
2
3
4
5
6
7
8
default_ipv4, Type: ipv4, State: active
Source IP
Protocol Dest Port
any
tcp
22
any
tcp
23
any
tcp
80
any
tcp
443
any
udp
161
any
udp
123
any
tcp
600 - 1023
any
udp
600 - 1023
Action
permit
permit
permit
permit
permit
permit
permit
permit
Name:
Rule
1
2
3
default_ipv6, Type: ipv6, State: defined
Source IP
Protocol Dest Port
any
tcp
22
any
tcp
23
any
tcp
80
Action
permit
permit
permit
Fabric OS Command Reference
53-1003108-01
503
2
ipFilter
4
5
6
7
8
any
any
any
any
any
tcp
udp
udp
tcp
udp
443
161
123
600 - 1023
600 - 1023
permit
permit
permit
permit
permit
Name: ex1, Type: ipv6, State: active
Rule
Source IP
Protocol
Dest Port Action
1 fec0:60:69bc:60:260:69ff:fe80:d4a tcp 23
permit
To create an IPv4-type IP filter policy:
switch:admin> ipfilter --create ex2 -type ipv4
To add a rule to the created policy "ex2":
switch:admin> ipfilter --addrule ex2 -sip 10.32.69.99 \
-dp 23 -proto tcp -act permit
To display the IP filter policies, including the new policy:
switch:admin> ipfilter --show
Name:
Name:
Rule
1
2
3
4
5
6
7
8
default_ipv4, Type: ipv4, State: active
default_ipv4, Type: ipv4, State: active
Source IP
Protocol Dest Port
any
tcp
22
any
tcp
23
any
tcp
80
any
tcp
443
any
udp
161
any
udp
123
any
tcp
600 - 1023
any
udp
600 - 1023
Action
permit
permit
permit
permit
permit
permit
permit
permit
Name: ex2, Type: ipv4, State: defined (modified)
Rule
Source IP
Protocol
Dest Port Action
1
10.32.69.99
tcp
23
permit
To save the IP Filter policy "ex2" (the status of the policy changes from modified to defined after the
policy is saved):
switch:admin> ipfilter --save ex2
switch:admin> ipfilter --show
Name: default_ipv4, Type: ipv4, State: active
Name: default_ipv4, Type: ipv4, State: active
Rule
Source IP
Protocol Dest Port
1
any
tcp
22
2
any
tcp
23
3
any
tcp
80
4
any
tcp
443
5
any
udp
161
6
any
udp
123
7
any
tcp
600 - 1023
8
any
udp
600 - 1023
Name: ex2, Type: ipv4, State: defined
Rule
Source IP
Protocol
1
10.32.69.99
tcp
504
Action
permit
permit
permit
permit
permit
permit
permit
permit
Dest Port Action
23
permit
Fabric OS Command Reference
53-1003108-01
ipFilter
2
To add a rule for traffic of type FORWARD and to display the result:
switch:admin> ipfilter --addrule ex2 -rule 1 -sip \
10.32.69.99 -dp 23 -proto tcp -act permit -type fwd
-dip 10.32.69.90
\
switch:admin> ipfilter --show -a
Legends: [Proto-Protocol, P-Permit, D-Deny, FWD-FORWARD, I/P-INPUT]
Name: default_ipv4,
Rule
Source_IP
1
any
2
any
3
any
4
any
5
any
6
any
7
any
8
any
Type: ipv4, State: active
Proto Dest_Port Action
Flow
tcp
22 P
I/P
tcp
23 P
I/P
tcp
80 P
I/P
tcp
443 P
I/P
udp
161 P
I/P
udp
123 P
I/P
tcp
600-1023 P
I/P
udp
600-1023 P
I/P
Destination_IP
any
any
any
any
any
any
any
any
Name: default_ipv6,
Rule
Source_I
1
any
2
any
3
any
4
any
5
any
6
any
7
any
8
any
Type: ipv6, State: active
Proto Dest_Port Action
Flow
tcp
22 P
I/P
tcp
23 P
I/P
tcp
80 P
I/P
tcp
443 P
I/P
udp
161 P
I/P
udp
123 P
I/P
tcp
600-1023 P
I/P
udp
600-1023 P
I/P
Destination_IP
any
any
any
any
any
any
any
any
Name: ex2, Type: ipv4, State: defined (modified)
Rule
Source_IP
Proto Dest_Port Action
Flow Destination_IP
1
10.32.69.99
tcp
23 P
FWD
10.32.69.99
SEE ALSO
distribute
Fabric OS Command Reference
53-1003108-01
505
2
ipSecConfig
ipSecConfig
Configures Internet Protocol security (IPSec) policies for Ethernet management interfaces.
SYNOPSIS
ipsecconfig --enable [default] --disable
ipsecconfig --add | --modify type [subtype] [arguments]
ipsecconfig --delete [type] arguments
ipsecconfig --flush manual-sa
ipsecconfig --show type [subtype] arguments
ipsecconfig --help [command_type subtype]
DESCRIPTION
Use this command to configure the Internet Protocol Security (IPSec) feature for traffic flows on switch
Ethernet management interfaces, or to display the current configuration.
Internet Protocol security (IPSec) is a framework of open standards that provides private, secure
communication over Internet Protocol (IP) networks through the use of cryptographic security services.
IPSec uses different protocols to ensure the authentication, integrity, and confidentiality of the
communication.
•
Encapsulating Security Payload (ESP) provides confidentiality, data integrity and data source
authentication of IP packets, and protection against replay attacks.
•
Authentication Header (AH) provides data integrity, data source authentication, and protection
against replay attacks, but unlike ESP, AH does not provide confidentiality.
IPSec can protect either the entire IP datagram or only the upper-layer protocols. The appropriate modes
are called tunnel mode and transport mode.
•
In tunnel mode the IP datagram is fully encapsulated by a new IP datagram using the IPSec
protocol.
•
In transport mode only the payload of the IP datagram is handled by the IPSec protocol; it inserts the
IPSec header between the IP header and the upper-layer protocol header.
The IPSec key management supports Internet Key Exchange (IKE) or Manual key/SA entry.
•
In IKE the IPSec protocol negotiates shared security parameters and keys. Security Associations
(SAs) used in IKE use automatically generated keys for authentication negotiation between peers.
•
Manual key/SA entry requires the keys to be generated and managed manually, and it is therefore
suited for small static environments. For the selected authentication or encryption algorithms, the
correct keys must be generated. The key length is determined by the algorithm selected. Refer to
the Fabric OS Administrator's Guide for more information.
The following IPSec configuration tasks can be performed with this command:
•
•
•
Enable or disable the IPSec policies.
Configure IP address for both IPv4 and IPv6 format.
Configure three types of policies and their respective components:
•
•
506
IPSec policy including selector, transform, SA-proposal, and SA.
IKE policy (automatic key management).
Manual SA (manual SA management).
Modify existing IPSec and IKE policies.
Delete existing policies and SAs from the configuration database.
Fabric OS Command Reference
53-1003108-01
ipSecConfig
•
•
2
Flush existing SAs from the kernel SA database (SADB).
Display policy parameters.
Representation of IP addresses
When configuring IPSec policies, IP addresses and ports must be specified in the following format:
IP address
IPv4 addresses are expressed in dotted decimal notation consisting of numeric
characters (0-9) and periods (.), for example, 203.178.141.194.
IPv6 address consist of hexadecimal digits (09afAF), colons (:) and a percent sign
(%) if necessary, for example, 2001:200:0:8002:203:47ff:fea5:3085
network prefix
A network prefix is represented by a number followed by a slash (/), for example,
1/0.
NOTES
IPSec configuration changes take effect upon execution and are persistent across reboot.
The execution of this command is subject to Virtual Fabric or Admin Domain restrictions that may be in
place. Refer to Chapter 1, "Using Fabric OS Commands" and Appendix A, "Command Availability" for
details.
This command does not provide IPSec protection for traffic flows on external management interfaces of
intelligent blades in a chassis, nor does it support protection of traffic flows on FCIP interfaces.
This command does not support manipulating preshared keys corresponding to the identity of the IKE
peer or group of peers. Use secCertUtil to import, delete, or display the preshared keys in the local
switch database.
The MD5 hash algorithm is blocked when FIPS mode is enabled.
Refer to the Examples section for specific use cases and associated command sequences. Refer to the
Fabric OS Administrator's Guide for configuration procedures.
This command accepts abbreviated operands. The abbreviated string must contain the minimum number
of characters necessary to uniquely identify the operand within the set of available operands.
OPERANDS
This command has the following operands:
--enable
Enables IPSec on the switch. Existing IPSec configurations are enabled by this
command. IPSec is disabled by default. It must be enabled before you can
configure the policies and parameters. The following operand is optional:
default
Clears the existing policies (automatic key management and manual keyed
entries) and resets the configuration databases to default values.
--disable
Disables IPSec on the switch. All active TCP sessions are terminated when you
disable iPsec.
--add | --modify
Adds or modifies an IPSec or IKE policy in an existing enabled configuration. Not
all parameters can be modified. Parameters that cannot be modified are indicated
below. When modifying a policy the names and identifiers need to refer to valid
existing entities. The syntax is as follows:
--add | --modify type [subtype] [arguments]
Fabric OS Command Reference
53-1003108-01
507
2
ipSecConfig
type
Specifies the policy to be created. Supported policies include the following:
policy ips
Creates or modifies an IPSec policy. This policy determines the security services
afforded to a packet and the treatment of a packet in the network. An IPSec policy
allows classifying IP packets into different traffic flows and specifies the actions or
transformations performed on IP packets on each of the traffic flows. The main
components of an IPSec policy are: IP packet filter/selector (IP address, protocol,
and port information) and transform set.
subtype
A subtype is required when configuring an IPSec policy. The subtype
specifies the components to be configured. The following are required
subtypes for the IPSec policy:
selector
Creates a selector that is applied to the IP data traffic. A selector consists of a
set of parameters that identify the IP traffic that needs IPSec protection. To
configure the selector, the following parameters must be specified:
-tag name
Specifies a name for the selector. This is a user-generated name. The name
must be between 1 and 32 characters in length, and may include
alphanumeric characters, dashes (-), and underscores (_).
-direction in | out
Specifies traffic flow direction as inbound or outbound.
-local IP_address[prefixlength]
Specifies the source IPv4 or IPv6 address.
-remote IP_address[/prefixlength]
Specifies the peer IPv4 or IPv6 address
-transform name
Specifies the transform to be included in the selector. You must create the
transform before you can use in the selector. Use ipsecConfig --show policy
ips transform to display existing transforms.
-protocol protocol_name
Specifies the upper layer protocols to be selected for IPSec protection. Valid
protocols include tcp, udp, icmp or any. When any is specified all existing
protocols are selected for protection. This operand is optional.
transform
Creates the IPSec transform set. The transform set is a combination of IPSec
protocols and cryptographic algorithms that are applied on the packet after it
is matched to a selector. The transform set specifies the IPSec protocol, the
IPSec mode, and the action to be performed on the IP packet. It also
specifies the key management policy that is needed for the IPSec connection
and the encryption and authentication algorithms to be used in security
associations when IKE is used as key management protocol. The following
operands are required:
-tag name
Specifies a name for the transform. This is a user-generated name. The
name must be between 1 and 32 characters in length, and may include
alphanumeric characters, dashes (-), and underscores (_).
508
Fabric OS Command Reference
53-1003108-01
ipSecConfig
2
-mode tunnel | transport
Specifies the IPSec transform mode. In tunnel mode, the IP datagram is fully
encapsulated by a new IP datagram using the IPSec protocol. In transport
mode, only the payload of the IP datagram is handled by the IPSec protocol
inserting the IPSec header between the IP header and the upper-layer
protocol header.
-sa-proposal name
Specifies the SA proposal to be included in the transform. You must create
the SA proposal first before you can include it in the transform. Use
ipsecConfig --show policy ips sa-proposal -a for a listing of existing SA
proposals.
-action discard | bypass | protect
Specifies the protective action the transform should take regarding the traffic
flows.
-ike name
Specifies the IKE policy to be included in the transform. This operand is
optional. Use ipsecConfig --show policy ike -a for a listing of existing IKE
policies.
-local IP_address[/prefixlength]
Specifies the source IPv4 or IPv6 address. This operand is optional. If a local
so