Page is loading ...
Broadcom FOS-90x-Command-RM102
17 August 2020
Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Reference Manual
17 August 2020
Copyright © 2020 Broadcom. All Rights Reserved. Broadcom, the pulse logo, Brocade, the stylized B logo, and
Fabric OS are among the trademarks of Broadcom in the United States, the EU, and/or other countries. The term “Broadcom”
refers to Broadcom Inc. and/or its subsidiaries.
Broadcom reserves the right to make changes without further notice to any products or data herein to improve reliability,
function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom does
not assume any liability arising out of the application or use of this information, nor the application or use of any product or
circuit described herein, neither does it convey any license under its patent rights nor the rights of others.
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, to view the
licensing terms applicable to the open source software, and to obtain a copy of the programming source code, please
download the open source disclosure documents in the Broadcom Customer Support Portal (CSP). If you do not have a CSP
account or are unable to log in, please contact your support provider for this information.
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Broadcom FOS-90x-Command-RM102
2
Broadcom FOS-90x-Command-RM102
3
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Table of Contents
Chapter 1: Introduction .................................................................................................................... 12
1.1 About This Document.............................................................................................................................................12
1.2 Supported Hardware...............................................................................................................................................12
1.2.1 Brocade Gen 7 (64Gb/s) Fixed-Port Switches................................................................................................12
1.2.2 Brocade Gen 7 (64Gb/s) Directors .................................................................................................................12
1.2.3 Brocade Gen 6 (32Gb/s) Fixed-Port Switches................................................................................................12
1.2.4 Brocade Gen 6 (32Gb/s) Directors .................................................................................................................12
1.3 CLI Usage Conventions..........................................................................................................................................12
1.4 Contacting Technical Support for Your Brocade
®
Product ................................................................................13
1.5 Document Feedback ...............................................................................................................................................13
Chapter 2: Using Fabric OS Commands ........................................................................................ 14
2.1 Using the Command Line Interface.......................................................................................................................14
2.2 Understanding Role-Based Access Control.........................................................................................................14
2.3 Understanding Virtual Fabric Restrictions ...........................................................................................................15
2.4 Determining the RBAC Permissions for a Specific Command ...........................................................................16
2.5 Shell Function Commands.....................................................................................................................................17
Chapter 3: Fabric OS Commands ................................................................................................... 18
aaaConfig ...............................................................................................................................18
ag ............................................................................................................................................28
agAutoMapBalance ................................................................................................................51
agShow ................................................................................................................................... 54
aliAdd ...................................................................................................................................... 58
aliCreate ................................................................................................................................. 60
aliDelete .................................................................................................................................. 62
aliRemove ...............................................................................................................................63
aliShow ................................................................................................................................... 65
appLoginHistory ...................................................................................................................... 67
appServer ............................................................................................................................... 69
aptPolicy ................................................................................................................................. 72
auditCfg .................................................................................................................................. 75
auditDump ..............................................................................................................................78
authUtil ................................................................................................................................... 80
bannerSet ............................................................................................................................... 85
bannerShow ...........................................................................................................................86
bcastShow ..............................................................................................................................87
bladeVerShow ........................................................................................................................89
bootLunCfg .............................................................................................................................91
cfgActvShow ........................................................................................................................... 93
cfgAdd .................................................................................................................................... 94
cfgClear .................................................................................................................................. 95
cfgCreate ................................................................................................................................97
cfgDelete ................................................................................................................................ 99
cfgDisable .............................................................................................................................100
cfgEnable ..............................................................................................................................102
Broadcom FOS-90x-Command-RM102
4
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
cfgRemove ...........................................................................................................................105
cfgSave .................................................................................................................................106
cfgShow ................................................................................................................................109
cfgSize ..................................................................................................................................114
cfgTransAbort .......................................................................................................................116
cfgTransShow ....................................................................................................................... 117
chassisBeacon .....................................................................................................................120
chassisCfgPerrThreshold .....................................................................................................122
chassisDisable ......................................................................................................................124
chassisDistribute .................................................................................................................. 125
chassisEnable ...................................................................................................................... 128
chassisName ........................................................................................................................129
chassisShow .........................................................................................................................130
chassisUpgrade ....................................................................................................................135
classConfig ...........................................................................................................................140
cliHistory ...............................................................................................................................145
configDefault .........................................................................................................................147
configDownload ....................................................................................................................150
configList ..............................................................................................................................157
configRemove .......................................................................................................................158
configShow ...........................................................................................................................160
configUpload .........................................................................................................................165
configure ...............................................................................................................................171
configureChassis ..................................................................................................................188
creditRecovMode ..................................................................................................................192
dataTypeShow ...................................................................................................................... 196
date ....................................................................................................................................... 198
dbgShow ...............................................................................................................................200
defZone ................................................................................................................................201
deviceLogin ..........................................................................................................................204
diagClearError ......................................................................................................................207
diagDisablePost .................................................................................................................... 208
diagEnablePost ....................................................................................................................209
diagHelp ...............................................................................................................................210
diagPost ................................................................................................................................211
diagShow ..............................................................................................................................212
diagStatus .............................................................................................................................214
distribute ...............................................................................................................................215
dlsReset ................................................................................................................................217
dlsSet ....................................................................................................................................219
dlsShow ................................................................................................................................224
dnsConfig .............................................................................................................................226
enclosureShow .....................................................................................................................229
errClear .................................................................................................................................232
errDelimiterSet ...................................................................................................................... 233
errDump ................................................................................................................................235
errFilterSet ............................................................................................................................241
errModuleShow ....................................................................................................................242
errShow ................................................................................................................................243
ethIf .......................................................................................................................................247
extnCfg .................................................................................................................................251
fabRetryShow .......................................................................................................................254
fabRetryStats ........................................................................................................................257
Broadcom FOS-90x-Command-RM102
5
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
fabricLog ...............................................................................................................................260
fabricName ...........................................................................................................................265
fabricNotification ...................................................................................................................267
fabricPrincipal .......................................................................................................................270
fabricShow ............................................................................................................................273
fabStatsShow .......................................................................................................................277
factoryFanShow ....................................................................................................................280
factoryReset .........................................................................................................................281
fanDisable ............................................................................................................................. 284
fanEnable .............................................................................................................................285
fanShow ................................................................................................................................286
faPwwn .................................................................................................................................288
fastBoot ................................................................................................................................295
fcipHelp .................................................................................................................................297
fcipLedTest ...........................................................................................................................298
fcipPathTest ..........................................................................................................................300
fcoe ....................................................................................................................................... 302
fcPing ....................................................................................................................................310
fcpLogClear ..........................................................................................................................319
fcpLogDisable ....................................................................................................................... 320
fcpLogEnable ........................................................................................................................ 321
fcpLogShow ..........................................................................................................................322
fcpProbeShow ......................................................................................................................323
fcpRlsProbe ..........................................................................................................................325
fcpRlsShow ...........................................................................................................................327
fcrBcastConfig ...................................................................................................................... 329
fcrConfigure ..........................................................................................................................331
fcrEdgeShow ........................................................................................................................ 334
fcrFabricShow .......................................................................................................................336
fcrIclPathBWMonitor .............................................................................................................339
fcrLsan ..................................................................................................................................341
fcrLsanCount ........................................................................................................................ 344
fcrLsanMatrix ........................................................................................................................346
fcrPhyDevShow ....................................................................................................................352
fcrProxyConfig ......................................................................................................................355
fcrProxyDevShow ................................................................................................................. 358
fcrResourceShow .................................................................................................................361
fcrRouterPortCost .................................................................................................................364
fcrRouteShow .......................................................................................................................366
fcrXlateConfig .......................................................................................................................368
fddCfg ...................................................................................................................................372
fdmiCacheShow ...................................................................................................................375
fdmiShow ..............................................................................................................................377
femDump ..............................................................................................................................383
ficonCfg ................................................................................................................................386
ficonClear .............................................................................................................................388
ficonCupSet ..........................................................................................................................390
ficonCupShow ...................................................................................................................... 395
ficonHelp ...............................................................................................................................399
ficonShow .............................................................................................................................400
fipsCfg ..................................................................................................................................412
firmwareActivate ................................................................................................................... 416
firmwareCheck ......................................................................................................................418
Broadcom FOS-90x-Command-RM102
6
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
firmwareCleanInstall .............................................................................................................420
firmwareCommit ...................................................................................................................423
firmwareDownload ................................................................................................................425
firmwareDownloadStatus ......................................................................................................431
firmwareKeyShow ................................................................................................................. 433
firmwareRestore ...................................................................................................................434
firmwareShow .......................................................................................................................435
firmwareSync ........................................................................................................................437
flow ....................................................................................................................................... 439
fosConfig ..............................................................................................................................474
fosExec .................................................................................................................................477
fpgaUpgrade ......................................................................................................................... 482
fpiProfile ................................................................................................................................484
frameLog ..............................................................................................................................487
fruDump ................................................................................................................................494
fspfShow ...............................................................................................................................497
gePortErrShow .....................................................................................................................501
gePortPerfShow ...................................................................................................................503
h ............................................................................................................................................506
haDisable ..............................................................................................................................507
haDump ................................................................................................................................508
haEnable ..............................................................................................................................511
haFailover............................................................................................................................. 512
haReboot ..............................................................................................................................513
haRedundancy .....................................................................................................................514
haShow ................................................................................................................................. 516
haShutdown ..........................................................................................................................518
haSyncStart ..........................................................................................................................519
haSyncStop ..........................................................................................................................520
help ....................................................................................................................................... 521
historyLastShow ................................................................................................................... 524
historyMode ..........................................................................................................................526
historyShow ..........................................................................................................................528
i .............................................................................................................................................531
iflShow ..................................................................................................................................534
interfaceShow .......................................................................................................................536
iodReset ...............................................................................................................................545
iodSet ...................................................................................................................................546
iodShow ................................................................................................................................548
ipAddrSet ..............................................................................................................................549
ipAddrShow ..........................................................................................................................556
ipFilter ................................................................................................................................... 559
islShow ................................................................................................................................. 565
itemList ................................................................................................................................. 568
killTelnet ...............................................................................................................................570
lacp .......................................................................................................................................572
ldapCfg .................................................................................................................................574
lfCfg ...................................................................................................................................... 578
license ..................................................................................................................................583
linkCost .................................................................................................................................588
lldp ..........................................................................................................................
.............. 591
logicalGroup .........................................................................................................................597
logout .................................................................................................................................... 603
Broadcom FOS-90x-Command-RM102
7
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
lsanZoneShow ......................................................................................................................604
lsCfg .....................................................................................................................................609
lsDbShow .............................................................................................................................618
mapsConfig ..........................................................................................................................623
mapsDb ................................................................................................................................630
mapsHelp .............................................................................................................................644
mapsPolicy ...........................................................................................................................645
mapsRule .............................................................................................................................650
mapsSam .............................................................................................................................668
memShow .............................................................................................................................671
motd ......................................................................................................................................673
mgmtApp ..............................................................................................................................675
msCapabilityShow ................................................................................................................682
msConfigure .........................................................................................................................684
msPlatShow ..........................................................................................................................686
msPlatShowDBCB ................................................................................................................688
msPlClearDB ........................................................................................................................ 689
msPlMgmtActivate ................................................................................................................690
msPlMgmtDeactivate ............................................................................................................691
msTdDisable .........................................................................................................................692
msTdEnable ......................................................................................................................... 694
msTdReadConfig ..................................................................................................................696
myId ......................................................................................................................................697
nbrShow ...............................................................................................................................698
nbrStateShow ....................................................................................................................... 705
nbrStatsClear ........................................................................................................................ 708
nodeFind ...............................................................................................................................710
nodeWWN ............................................................................................................................713
nsAliasShow .........................................................................................................................715
nsAllShow .............................................................................................................................720
nsCamShow .........................................................................................................................722
nsDevLog .............................................................................................................................725
nsShow ................................................................................................................................. 728
nsZoneMember ....................................................................................................................733
nsZoneShow .........................................................................................................................737
openSource ..........................................................................................................................740
passwd ................................................................................................................................. 742
passwdCfg ............................................................................................................................746
pathBwConfig .......................................................................................................................755
pathInfo ................................................................................................................................. 757
pdShow ................................................................................................................................. 766
portAddress ..........................................................................................................................768
portBeacon ...........................................................................................................................772
portBufferCalc .......................................................................................................................775
portBufferShow .....................................................................................................................777
portCamShow .......................................................................................................................781
portCfg ..................................................................................................................................784
portCfgAutoDisable ..............................................................................................................818
portCfgBreakout ................................................................................................................... 823
portCfgCleanAddress ...........................................................................................................825
portCfgCompress ...............................................................................................................
..827
portCfgCongestionSignal ...................................................................................................... 829
portCfgCreditRecovery .........................................................................................................830
Broadcom FOS-90x-Command-RM102
8
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
portCfgDefault ...................................................................................................................... 832
portCfgDPort ......................................................................................................................... 834
portCfgEncrypt ...................................................................................................................... 838
portCfgEport ......................................................................................................................... 841
portCfgEportCredits ..............................................................................................................844
portCfgEXPort ......................................................................................................................847
portCfgFaultDelay .................................................................................................................851
portCfgFec ............................................................................................................................854
portCfgFlexPort ....................................................................................................................860
portCfgFlogiLogout ...............................................................................................................862
portCfgFportBuffers ..............................................................................................................864
portCfgGE .............................................................................................................................866
portCfgISLMode ...................................................................................................................870
portCfgLongDistance ............................................................................................................872
portCfgLossTov ....................................................................................................................876
portCfgNPIVPort ................................................................................................................... 878
portCfgNPort ......................................................................................................................... 881
portCfgOctetSpeedCombo ...................................................................................................883
portCfgPersistence ...............................................................................................................886
portCfgPersistentDisable ......................................................................................................888
portCfgPersistentEnable....................................................................................................... 891
portCfgQoS ...........................................................................................................................894
portCfgShow .........................................................................................................................897
portCfgSpeed .......................................................................................................................912
portCfgTdz ............................................................................................................................916
portCfgTrunkPort ..................................................................................................................918
portCfgUpload ......................................................................................................................920
portChannel ..........................................................................................................................923
portChannelShow .................................................................................................................928
portCmd ................................................................................................................................931
portDecom ............................................................................................................................942
portDisable ........................................................................................................................... 945
portDPortTest .......................................................................................................................948
portEnable ............................................................................................................................ 959
portEncCompShow ...............................................................................................................962
portErrShow ..........................................................................................................................964
portFlagsShow ...................................................................................................................... 968
portImpair .............................................................................................................................970
portLedTest ..........................................................................................................................972
portLogClear ......................................................................................................................... 975
portLogConfigShow ..............................................................................................................976
portLogDisable ..................................................................................................................... 977
portLogDump ........................................................................................................................978
portLogDumpPort .................................................................................................................980
portLogEnable ...................................................................................................................... 982
portLogEventShow ...............................................................................................................983
portLoginShow ...................................................................................................................... 985
portLogReset ..................................................................................................................
......988
portLogResize ......................................................................................................................989
portLogShow ........................................................................................................................ 990
portLogShowPort ................................................................................................................1000
portLogTypeDisable ........................................................................................................... 1002
portLogTypeEnable ............................................................................................................ 1003
Broadcom FOS-90x-Command-RM102
9
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
portLoopbackTest ...............................................................................................................1004
portName ............................................................................................................................1009
portPeerBeacon ..................................................................................................................1013
portPerfShow ...................................................................................................................... 1016
portShow ............................................................................................................................1021
portStats64Show ................................................................................................................1097
portStatsClear .....................................................................................................................1104
portStatsShow ....................................................................................................................1106
portTest ..............................................................................................................................1120
portTestShow .....................................................................................................................1124
portTrunkArea .....................................................................................................................1127
portZoneShow ....................................................................................................................1133
powerOffListSet ..................................................................................................................1135
powerOffListShow .............................................................................................................. 1138
psShow ............................................................................................................................... 1140
psUtil ................................................................................................................................... 1142
rasAdmin ............................................................................................................................ 1145
rasMan ................................................................................................................................ 1150
reboot ................................................................................................................................. 1152
relayConfig ......................................................................................................................... 1154
roleConfig ...........................................................................................................................1156
ron ...................................................................................................................................... 1160
rootAccess ..........................................................................................................................1162
routeHelp ............................................................................................................................1164
sBoot .................................................................................................................................. 1165
sddQuarantine .................................................................................................................... 1167
secActiveSize .....................................................................................................................1170
secAuthSecret .................................................................................................................... 1171
secCertMgmt ......................................................................................................................1174
secCryptoCfg ...................................................................................................................... 1181
secDefineSize .....................................................................................................................1188
secPolicyAbort .................................................................................................................... 1189
secPolicyActivate ................................................................................................................1190
secPolicyAdd ......................................................................................................................1192
secPolicyCreate ..................................................................................................................1195
secPolicyDelete ..................................................................................................................1199
secPolicyDump ...................................................................................................................1201
secPolicyFCSMove ............................................................................................................ 1204
secPolicyRemove ............................................................................................................... 1206
secPolicySave ....................................................................................................................1209
secPolicyShow ................................................................................................................... 1210
secStatsReset ....................................................................................................................1212
secStatsShow .....................................................................................................................1214
sensorShow ........................................................................................................................1216
setContext ..........................................................................................................................1217
setDbg ................................................................................................................................1219
setVerbose .........................................................................................................................1220
sfpShow ..............................................................................................................................1221
shellFlowControlDisable ..................................................................................................... 1233
shellFlowControlEnable ...................................................................................................... 12
34
slotCfgPersistence ..............................................................................................................1235
slotPowerOff .......................................................................................................................1237
slotPowerOn .......................................................................................................................1239
Broadcom FOS-90x-Command-RM102
10
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
slotShow .............................................................................................................................1240
slotStatsClear .....................................................................................................................1246
snmpConfig ........................................................................................................................1248
snmpStatistics ....................................................................................................................1266
snmpTraps ..........................................................................................................................1269
spinFab ...............................................................................................................................1273
sshUtil ................................................................................................................................. 1278
statsClear ........................................................................................................................... 1286
stopPortTest ....................................................................................................................... 1288
supportFfdc ......................................................................................................................... 1289
supportFtp .......................................................................................................................... 1290
supportInfoClear .................................................................................................................1293
supportLink ......................................................................................................................... 1295
supportSave ....................................................................................................................... 1302
supportShow ....................................................................................................................... 1309
supportShowCfgDisable ..................................................................................................... 1314
supportShowCfgEnable ......................................................................................................1317
supportShowCfgShow ........................................................................................................1320
switchBeacon .....................................................................................................................1322
switchCfgPersistentDisable ................................................................................................1324
switchCfgPersistentEnable .................................................................................................1326
switchCfgSpeed ..................................................................................................................1327
switchCfgTrunk ...................................................................................................................1329
switchDisable...................................................................................................................... 1331
switchEnable ......................................................................................................................1332
switchName ........................................................................................................................1333
switchShow .........................................................................................................................1335
switchViolation .................................................................................................................... 1358
sysHealth ............................................................................................................................1359
syslogAdmin .......................................................................................................................1361
sysShutDown ......................................................................................................................1364
tcpTimeStamp ....................................................................................................................1366
tempShow........................................................................................................................... 1368
timeOut ............................................................................................................................... 1370
topologyShow .....................................................................................................................1372
traceDump ..........................................................................................................................1377
trunkDebug .........................................................................................................................1380
trunkShow ........................................................................................................................... 1382
tsClockServer .....................................................................................................................1387
tsTimeZone .........................................................................................................................1389
turboRamTest .....................................................................................................................1393
upTime ................................................................................................................................1395
uRouteShow .......................................................................................................................1396
usbStorage .........................................................................................................................1399
userConfig ..........................................................................................................................1401
version ................................................................................................................................1409
wwn ....................................................................................................................................1411
wwnAddress .......................................................................................................................1413
wwnRecover ....................................................................................................................... 1416
zone ....................................................................................................................................1419
zoneAdd .............................................................................................................................1429
zoneCreate ....................................................................................................................
.....1432
zoneDelete ......................................................................................................................... 1435
Broadcom FOS-90x-Command-RM102
11
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
zoneFabricLock ..................................................................................................................1436
zoneHelp ............................................................................................................................1438
zoneObjectCopy .................................................................................................................1440
zoneObjectExpunge ........................................................................................................... 1442
zoneObjectRename ............................................................................................................ 1444
zoneObjectReplace ............................................................................................................ 1446
zoneRemove ......................................................................................................................1448
zoneShow ........................................................................................................................... 1451
Chapter 4: Primary FCS Commands ........................................................................................... 1459
Chapter 5: Command Availability ............................................................................................... 1461
5.1 Command Validation Checks.............................................................................................................................1461
5.2 Virtual Fabric and Remote Domain Execution Command Restrictions.........................................................1461
Revision History ........................................................................................................................... 1472
FOS-90x-Command-RM102; 17 August 2020 ......................................................................................................... 1472
Modified Commands................................................................................................................................................. 1472
FOS-90x-Command-RM101; 23 June 2020 ............................................................................................................. 1472
Modified Commands .............................................................................................................................................1472
FOS-90x-Command-RM100; 30 April 2020.............................................................................................................. 1473
New Commands ...................................................................................................................................................1473
Modified Commands .............................................................................................................................................1473
Deprecated Commands ........................................................................................................................................1474
Broadcom FOS-90x-Command-RM102
12
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Chapter 1: Introduction
1.1 About This Document
This Brocade
®
Fabric OS
®
Command Reference Manual details the commands that can be issued on devices that support
Fabric OS 9.0.0x. This manual documents all officially supported Fabric OS commands. Any commands not listed in this
command reference are not supported and may be subject to removal without notification.
1.2 Supported Hardware
The following hardware platforms are supported by Brocade Fabric OS 9.0.0x.
1.2.1 Brocade Gen 7 (64Gb/s) Fixed-Port Switches
Brocade G720 Switch
1.2.2 Brocade Gen 7 (64Gb/s) Directors
For ease of reference, Brocade chassis-based storage systems are standardizing on the term director. The legacy term
backbone can be used interchangeably with the term director.
Brocade X7-4 Director
Brocade X7-8 Director
1.2.3 Brocade Gen 6 (32Gb/s) Fixed-Port Switches
Brocade G610 Switch
Brocade G620 Switch
Brocade G630 Switch
Brocade 7810 Extension Switch
Brocade G648 Blade Server SAN I/O Module
Brocade MXG610 Blade Server SAN I/O Module
1.2.4 Brocade Gen 6 (32Gb/s) Directors
Brocade X6-4 Director
Brocade X6-8 Director
1.3 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 input to other commands, you must remove the leading
zeros; otherwise the commands will fail or generate incorrect results. Adding zeros to any decimal number in command
input will cause that number to be treated as an octal number.
The entire command line (both commands and options) is case-sensitive. Selected command names and options may
also support Java-style capitalization. Java-style capitalization means that while
bannershow and bannerShow will both
work,
BANNERSHOW and BannerShow will not work. Command options, on the other hand, are strictly case-sensitive, and
Broadcom FOS-90x-Command-RM102
13
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
therefore only lower-case or Java-style capitalization can be entered depending on each option. This means that while
the
-USB option of the configDownload command works, the -usb option will not work. Refer to the command syntax for
explicit instructions on supported capitalization for each command and its options.
Almost all commands have both Hungarian and all lower case notations. Entries for both these notations are there in
execution path. User may execute a command in either notation. The FOS documentation uses both there notations
interchangeably in online and offline man pages.
When command examples in this guide show user input enclosed in quotation marks, the quotation marks are required.
Example:
zonecreate “zonename” requires that the value for zonename be in quotation marks.
Automatic page breaks in CLI command output 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. Issuing help command |
more
displays a “no manual entry for command” message.
1.4 Contacting Technical Support for Your Brocade
®
Product
For product support information and the latest information on contacting the Technical Assistance Center, go to https://
www.broadcom.com/support/fibre-channel-networking/. If you have purchased Brocade
®
product support directly from
Broadcom, use one of the following methods to contact the Technical Assistance Center 24x7.
If you purchased Brocade product support from a Broadcom OEM/solution provider, contact your OEM/solution provider for
all your product support needs.
OEM/solution providers are trained and certified by Broadcom to support Brocade products.
Broadcom provides backline support for issues that cannot be resolved by the OEM/solution provider.
Brocade Supplemental Support augments your existing OEM support contract, providing direct access to Brocade
expertise. For more information, contact Broadcom or your OEM.
For questions regarding service levels and response times, contact your OEM/solution provider.
1.5 Document Feedback
Quality is our first concern. We have made every effort to ensure the accuracy and completeness of this document. However,
if you find an error or an omission or if you think that a topic needs further development, we want to hear from you. Send
your feedback to [email protected]. Provide the publication title, publication number, topic heading, page
number, and as much detail as possible.
Online Telephone
For nonurgent issues, the preferred method is to log in to
myBroadcom at https://www.broadcom.com/mybroadcom. (You
must initially register to gain access to the Customer Support
Portal.) Once there, select Customer Support Portal > Support
Portal. You will now be able to navigate to the following sites:
Knowledge Search: Clicking the top-right magnifying glass
brings up a search bar.
Case Management: The legacy MyBrocade case
management tool (MyCases) has been replaced with the
Fibre Channel Networking case management tool.
DocSafe: You can download software and documentation.
Other Resources: Licensing Portal (top), SAN Health (top
and bottom), Communities (top), Education (top).
Required for Severity 1 (critical) issues:
Please call Fibre Channel Networking Global Support at one of the
numbers listed at https://www.broadcom.com/support/fibre-
channelnetworking/.
Broadcom FOS-90x-Command-RM102
14
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Chapter 2: Using Fabric OS Commands
2.1 Using the Command Line Interface
The Fabric OS command line interface (CLI), accessed via Telnet, SSH, or a 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 according to 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
2.2 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 1. These predefined role definitions are guided by perceived common operational
situations and the operations and effects that a role is permitted to have on a fabric and individual fabric elements.
Table 1: Role Definitions
Role Name Definition
Admin All administrative tasks, including encryption and chassis commands.
BasicSwitchAdmin A subset of administrative tasks, typically of a more limited scope and effect.
FabricAdmin Administrative use excluding user management.
Operator A subset of administrative tasks typically required for routine maintenance operations.
SecurityAdmin Administrative use including admin, encryption, security, user management, and
zoning.
SwitchAdmin Administrative use excluding security, user management, and zoning.
User Nonadministrative use, such as monitoring system activity. In Fabric OS 6.2.0 and later,
the user account gains access to Fabric ID 128. This is the default logical fabric after a
firmware upgrade.
ZoneAdmin Zone management only.
Broadcom FOS-90x-Command-RM102
15
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
In addition to these predefined roles, Fabric OS 7.4.2 and later provide support for creating user-defined roles. See the
roleConfig command for more information.
NOTE: While executing any command such as
classConfig, the OperandPresent string in the options column indicates
that an option must be present with the command for successful execution.
Additional command restrictions apply depending on whether Virtual Fabrics is enabled in a fabric. See
Command Availability.
2.3 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 issued in one or more of the contexts described in Table 2.
Issuing of chassis commands requires chassis permissions.
Switch commands are further defined by the switch type restrictions described in Table 3. Switch type restrictions are not
applicable to commands that require chassis permissions.
In a Virtual Fabric environment where contexts are enforced, the following Virtual Fabric restrictions apply to the RBAC
permissions specified in Table 1. See the
userConfig command for more information on configuring user account access
permissions in a Virtual Fabric environment.
Any given role is allowed to issue 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 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
issue chassis-level commands at the user RBAC access level. An admin account with the chassis role can issue
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. See
Chapter 5, Command Availability, for a complete listing of Virtual Fabric restrictions that apply to the commands included in
this manual.
Table 2: 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 issued.
Switch and chassis
context
Command can be issued in a logical switch context or in a chassis context.
Disallowed Command is not supported in Virtual Fabric mode.
Table 3: Switch Types
Switch Type Definition
All Switches Command can be issued in any switch context.
Base Switch Only Command can be issued only on the base switch.
Default Switch Only Command can be issued only on the default switch.
N/A Command is a chassis command or is not supported in Virtual Fabric mode.
Broadcom FOS-90x-Command-RM102
16
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
2.4 Determining the RBAC Permissions for a Specific Command
To determine the RBAC permissions for a specific command, use the classconfig 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. The command
passed as an argument must use only lowercase letters. 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 that you want to look
up.
The command displays the default roles and the permissions to access commands in the specified RBAC class.
The following example shows how you can obtain permission information for the
zone command. Suppose that 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 a 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.
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 Permission
--------- ----------
User O
Admin OM
Factory OM
Root OM
Operator O
SwitchAdmin O
ZoneAdmin OM
FabricAdmin OM
BasicSwitchAdmin O
SecurityAdmin 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 that
associated commands in that class are restricted and cannot be issued in that role.
Broadcom FOS-90x-Command-RM102
17
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
2.5 Shell Function Commands
The following commands are used by Fabric OS to support certain shell functions. Users should not run these commands
directly.
commandComplete
mail_handler
saveHistory
saveHistoryOnReboot
The following commands are used for administrative functions and will fail when run directly:
export_switch
set_console_switch
set_switch_inst
setSlot
Broadcom
FOS-90x-Command-RM102
18
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
Chapter 3: Fabric OS Commands
aaaConfig
Manages RADIUS, LDAP, and TACACS+ configuration information.
Synopsis
aaaconfig
aaaconfig --show -npage
aaaconfig --add
| --change server -conf radius | ldap | tacacs+
[
-p port] [-d domain] [-t timeout] [-s secret]
[
-a chap | pap | peap-mschapv2] [-e -encr_type none | aes256]
aaaconfig --remove server -conf radius | ldap | tacacs+
aaaconfig --move server -conf radius | ldap | tacacs+ to_position
aaaconfig --authspec aaa1[;aaa2] [-backup]] [-nologout]
[
-logpriauth yes | no]
aaaconfig --help
Description
Use this command to manage the RADIUS, LDAP, and TACACS+ server configuration for the Authen-
tication, 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 and 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). Also
supported is Lightweight Directory Access Protocol (LDAP) authentication against Active Directory for
user authentication and authorization.
RADIUS, LDAP, or TACACS+ servers are contacted in the order in which they appear in the configura-
tion list. The first server that returns 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 is logged 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 that a server
is added, removed, or modified. Refer to the Brocade 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 configu-
ration applies to all switch instances in a platform that supports multiple switch domains.
Broadcom
FOS-90x-Command-RM102
19
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
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 issued when logged in through the console, Telnet, or an SSH connection.
This command is subject to Virtual Fabrics restrictions that may be in place. See "Using Fabric OS
Commands" and "Command Availability" for details.
Operands
This command has the following operands:
server
Specifies an IP address or a server name in dotted-decimal notation. IPv6 addresses are
supported. If a name is used, a DNS entry must be correctly configured for the server. If the spec-
ified 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, and another specified by the IP address.
--show
Displays the current AAA service configuration. Use -npage option to display details without any
page breaks.
--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 five 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 RADIUS, LDAP, or TACACS+. This operand is required.
The following operands are optional:
-p port
Specifies the RADIUS, LDAP, or TACACS+ server port number. The supported range is 1 to
65535. The default port is 1812 for RADIUS authentication, 1813 for RADIUS accounting, and
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.
Broadcom
FOS-90x-Command-RM102
20
Reference Manual Brocade
®
Fabric OS
®
Command Reference Manual, 9.0.x
-t timeout
Specifies the response timeout for the RADIUS, LDAP, or TACACS+ server. The supported
range is 1 to 30 seconds. The default is 3 seconds. This operand is optional. If no timeout is spec-
ified, the default is used.
-d domain
Specifies the domain name for the LDAP server, for example, broadcom.com. This option is valid
only with the
-conf ldap option and takes "local" as default if domain value is not provided. This
operand is optional.
-s secret
Specifies a common secret between the switch and the RADIUS or TACACS+ server. The secret
must be 8 to 40 characters for a RADIUS server and 1 to 40 characters for TACACS+ server. This
option is valid only with the
-conf radius or -conf tacacs+ options, and it is optional. The default
value is
sharedsecret. The secret can include any printable ASCII character from 0x21 to 0x7E.
Spaces are not allowed.
-a
Specifies the remote authentication protocol for the RADIUS or TACACS+ server. This operand
is valid with the
-conf radius or -conf tacacs+ options, and it is optional. The default value for this
operand is
CHAP.
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. This is applicable only to RADIUS configuration.
-e encr_type
Specifies the encryption algorithm. This is applicable to both RADIUS and TACACS+ configura-
tions. Valid algorithms include the following:
none
Null encryption algorithm.
/