Further reading
Other documentation about the Broadcom diag shell. Most of it describes other
chips or other network operating systems that wrap the same shell (for example
Cisco NX-OS bcm-shell, Cumulus Linux bcmcmd or SONiC bcmsh); the
command syntax is largely shared, but output and available commands differ.
Seed documents
bcmsh.md (published as https://kamelnetworks.github.io/sonic/bcmsh.html)
- Link:
- Author:
Kamel Networks (Christian Svensson)
- Date:
2024-02-29
- Covers:
pbmp; port naming (xe/ce/cpu0); knet; cint; config variables (portmap_N); flexport via init all; dmirror to CPU for tcpdump; ESW; DEFIP
- Commands:
help,show unit,show param,ps,show pmap,phy diag,pbmp,port,show counters,bsv,pciephy fw version,cancun stat,crm show resources,bcmsai mptnl dip detail,dump chg,portmod info pm,portmod eyescan,vlan create,pvlan set,dmirror,l3 intf show,l3 intf destroy,l3 intf add,l2 add,l3 defip show,l3 ip6route show,l3 egress show,l3 ip6route add,config,init all,cint
led.md (SONiC on Broadcom: LED debugging)
- Link:
- Author:
Kamel Networks
- Date:
2024-02-29
- Covers:
CMIC LED processor; led_control_data via cint
- Commands:
bsv,led auto,led,cint
Broadcom official public material (OpenBCM, OpenNSL, OF-DPA)
OF-DPA 2.0 client_drivshell.c
- Link:
- Author:
Broadcom Corporation (Apache-2.0), published in Open Network Linux repo
- Date:
2015-09-24 (commit); file header 2003-2014
- Covers:
argv joined into one shell command line, 200-byte buffer limit; ofdpaClientInitialize/ofdpaBcmCommand
SDK-6.5.20 HSDK Getting Started Guide (GS-SDK6520-R), plus SDK-6.5.20/21/22 Release Notes (RN-SDK65xx-R)
- Link:
- Author:
Broadcom
- Date:
2020-07 (GSG); 2021-03 (6.5.22 RN)
- Covers:
BCM.0> vs BCMLT.0> (SDKLT) vs cint> prompts; command abbreviation (capitalised prefix); common vs mode-specific vs dynamic commands; rc/ltsw.soc; bcm.user -y config.yml; official doc IDs: StrataXGS-AN300-R ‘BCM Diagnostic Shell’, 56XX-PG-1001-R ‘CINT Interface for Diagnostic Shell’, 56XXX-AN301-R ‘KNET’
- Commands:
help,?,bsh,dsh,cint,exit,assert,attach,background,break,case,cd,clearscreen,config,console,copy,cpudb,ctecho,ctinstall,ctsetup,date,dbdump,dbparse,debug,delay,dir,dispatch,echo,expr,flashinit,flashsync,for,history,if,import,jobs,kill,led,local,log,loop,ls,mkdir,mode,more,move,noecho,pause,printenv,probe,ptp,pwd,quit,rccache,rcload,reboot,rename,reset,rm,rmdir,rpc,salprofile,save,set,setenv,shell,sleep,tdpll,time,version,alpm,asf,bcmltshell,clear,cos,counter,customstat,debugshell,detach,dump,eventstat,fieldprocessor,flexctr,flexdigest,flexport,flowdb,ha,init,ipmc,l2,l3,linkscan,memscan,mirror,mpls,multicast,packetwatcher,pbmp,port,portstat,pvlan,rate,ratebw,ser,show,sramscan,stackportget,stackportset,stg,stkmode,switchcontrol,trace,trunk,tx,vlan,warmboot,xmem,cancun stat,warmboot storage,techsupport
OpenBCM sdk-6.5.27/rc: rc.soc, config.bcm, td3_sanity.soc, cmd_td3_tr514_lr.soc, tr51/tr517_bcm56870_a0.soc, bcm_diag_info.soc …
- Link:
- Author:
Broadcom
- Date:
2023
- Covers:
rc.soc boot script; sanity/test scripts; config.bcm syntax; TR (test registry) numbers for BCM56870; $unit/$pbm variables
- Commands:
if,local,setenv,rcload,rccache,init,port,phy,linkscan,led,vlan,trunk,stkmode,write,mcsload,tr,echo,date,cancun,set,memscan,sramscan,counter,l2mode,ver,ts,tm,tl,time,soc,config,ps,show,version,lls,hsp,fp,dump,setreg
OpenBCM sdk-6.5.27 CINT interpreter sources (src/appl/cint, src/appl/diag/cint) and Trident 3 CINT examples with logs (src/examples/xgs/TD3)
- Link:
- Author:
Broadcom
- Date:
2023
- Language:
C
- Covers:
CINT grammar and supported C subset; cint list/var/typecheck interpreter commands; printf $variable interpolation; cint_reset, ARGC/ARGV; bshell() from CINT; TD3 CINT example programs and their console logs
- Commands:
cint
OpenBCM sdk-6.5.27 SDK API headers (include/bcm/*.h) and the Cint registration data generated from them (bcm_cint_data.c)
- Link:
- Author:
Broadcom
- Date:
2023
- Language:
C
- Covers:
bcm_* function prototypes, structures, enums and flags with comments; list of functions and types registered with Cint in the public release; CINT example programs per XGS chip family
- Commands:
cint
SDK-6.5.20..6.5.27 Resolved-Issues-Improvements.xlsx (7 files)
- Link:
- Author:
Broadcom
- Date:
2020..2023
- Covers:
per-release behaviour changes of shell commands; DNX-only commands (pp vis, dbal, tm, diag pp, flexe)
- Commands:
show counter,show c,l2 show,l2 info,l2 add,l2 clear,l3 ip6route,l3 egress,phy diag,phy eyescan,phy cl72,phy raw,pciephy,mirror dest show,fp range,flexctr,exit clean,tx,port status,vlan show,led load,soc,warmboot swstate_size,tr,field group,prbs get
OpenNSL 3.x documentation (doc/html) and sal/driver.h (opennsl_driver_shell)
- Link:
https://github.com/opennetworklinux/OpenNSL/tree/87f02fb224646d97d05e92b8883a5bd6a0cae80e/doc/html
- Author:
Broadcom (mirrored by Open Network Linux after Broadcom-Switch/OpenNSL was removed)
- Date:
2018-05-16
- Covers:
drivshell> prompt origin: opennsl_driver_shell(); knet
SONiC project sources
docker-syncd-brcm bcmsh and base_image_files/bcmcmd wrappers
- Link:
- Author:
SONiC project (sonic-net)
- Date:
2026
- Covers:
sswsyncd.socket; single-client shell; inactivity timeout
sonic-buildimage issues with bcmcmd usage (exemplars #1762, #3212, #10733, #22287, #28832)
- Link:
https://github.com/sonic-net/sonic-buildimage/issues?q=bcmcmd
- Author:
SONiC community
- Date:
2018-06-01..2026-08-04
- Covers:
THDI_PORT_PRI_GRP0 register access by port suffix (.ce6); M0 LED firmware status; socket contention
- Commands:
ps,m0 status,getreg,bcmsai ver
Generalizing config.bcm support for BRCM silicons (HLD) + SONiC 202106 release notes
- Link:
https://github.com/sonic-net/SONiC/blob/master/doc/platform/common_config.md
- Author:
SONiC project (sonic-net)
- Date:
2024-11-15
- Covers:
config.bcm; per-ASIC common config (broadcom-sonic-td3.config.bcm); sai.profile; inheritance precedence
sonic-mgmt test suite files invoking bcmcmd (19 files)
- Link:
https://github.com/sonic-net/sonic-mgmt/tree/8b8287ff4698eea79ad35dd7ca75948ea1b4d07d
- Author:
SONiC project (sonic-net)
- Date:
2026
- Covers:
RTAG7 hash seeds; switch controls (sc); SER injection; cint file execution; modify memory field (modi port … OUTER_TPID_ENABLE)
- Commands:
bsv,cint,clear counters,config show,cstat,dump,getreg,setreg,sc,ser capability,knetctrl netif show,l3 defip show,show c,show counters,show pmap,modi,modify,fp detach,fp init,ps,port status,port enable
bcmshell.py (Python client for the BCM diag shell socket)
- Link:
- Author:
Cumulus Networks (2012), carried in SONiC
- Date:
2022-06-09
- Covers:
port name mapping xe* to swp*; table dump parsing
- Commands:
getreg,getreg raw,dump all
broadcom-sonic-td3.config.bcm and common_config_readme
- Link:
- Author:
Broadcom via SONiC project
- Date:
2026
- Covers:
config.bcm variables (spn_*); sai_load_hw_config (Cancun); flowtracker/IFA config
- Commands:
config
SONiC User Manual (section 6.2 example: bcmcmd “ps”)
- Link:
https://github.com/sonic-net/SONiC/blob/master/doc/user-manual/SONiC-User-Manual.md
- Author:
SONiC project (sonic-net)
- Date:
2025-11-12
- Covers:
ps column meanings
- Commands:
ps
scripts/generate_dump (show techsupport collector)
- Link:
- Author:
SONiC project (sonic-net)
- Date:
2026
- Covers:
XGS vs DNX vs HSDK (ltsw) command sets; /proc/bcm/knet/*; multi-ASIC namespaces; command timeouts
- Commands:
version,soc,attach,stkmode,ps,show unit,bsh,l2 show,field group list,field group info,show feature,l3 nat_ingress show,l3 nat_egress show,ipmc table show,multicast show,fp show,pvlan show,l3 intf show,l3 egress show,mc show,cstat,mirror show,mirror dest show,port,conf show,l3 defip show,l3 l3table show,l3 ecmp egress show,l3 multipath show,l3 ip6host show,l3 ip6route show,d chg my_station_tcam,show config lt raw,l3 route show,l3 host show,l3 ecmp show,l2 station show,bcmltshell,dbal table dump,port mgmt dump full,tm lag,pp info fec,nif sts,tm ing q map,port pm info,show counters,diag counter g,fabric connectivity,port status
SONiC wiki: technical_faq (bcmcmd polling socket timeout)
- Link:
- Author:
SONiC community
- Date:
2026-10-08
- Covers:
polling socket timeout = syncd dead
- Commands:
ps
Network-vendor documentation that wraps the BCM shell
cPCI-6S10 Series 6U CompactPCI Switch Blade User’s Manual (50-15099-1000, Rev 1.0)
- Link:
- Author:
ADLINK Technology
- Date:
2018-09-03
- Covers:
BCM56150 (Hurricane2); bcm.user/netserve; rc.soc; customer_config.soc; config.bcm properties (pbmp_xport_xe, phy_port_primary_and_offset); LEDuP firmware load
- Commands:
setreg,led stop/load/auto/start,phy,port if=sfi an= speed= rpau= tpau=,bcm,bcmx,cint,config,debug,debugmod,rccache,rcload,version
OmniSwitch 6860, 6900, 10K Troubleshooting Guide
- Link:
https://www.scribd.com/document/336171966/OmniSwitch-6860-6900-10K-Troubleshooting-Guide
- Author:
Alcatel-Lucent Enterprise (uploader Yong Lee Tay)
- Covers:
bShell troubleshooting section
ASIC-level Shell Access (Open NX-OS)
- Link:
https://developer.cisco.com/docs/nx-os/asic-level-shell-access/
- Author:
Cisco (DevNet)
- Covers:
unit numbers; bcm-shell.N> prompt; dev-ops role ‘bcm module *’ permit rule; vendor wrapper for the BCM shell on Nexus 9000
- Commands:
vlan,l2 show,vlan <id>
Cisco Nexus 3000 Series NX-OS Programmability Guide, Release 7.x – Broadcom Shell
- Link:
- Author:
Cisco
- Date:
2015-09-11
- Covers:
T2 instance selection; wildcard ‘*’
- Commands:
exit
Cisco Nexus 3000 Series NX-OS Programmability Guide, Release 9.2(x) – Packetized MMU Stats
- Link:
- Author:
Cisco
- Date:
2019-03-01
- Covers:
config.bcm soc properties buffer_stats_collect_mode / buffer_stats_collect_type
- Commands:
config show
Cisco Nexus 3000 Series NX-OS Programmability Guide, Release 9.3(x) – Broadcom Shell
- Link:
- Author:
Cisco
- Date:
2020-09-03
- Covers:
T2 instance selection
- Commands:
exit
Cisco Nexus 3000 Series NX-OS QoS Configuration Guide, Release 7.x – Configuring QoS
- Link:
- Author:
Cisco
- Date:
2020-08-31
- Covers:
MMU_THDU_XPIPE_CONFIG_QUEUE; Q_SHARED_ALPHA_CELL; mmu0 instance suffix; dump changed fields
- Commands:
d chg
Nexus 9500-R, Nexus 3000-R: Troubleshoot Input Discards
- Link:
- Author:
Cisco TAC
- Date:
2018-11-02
- Covers:
DNX/Jericho shell (not XGS); IQM_QUEUE_DELETED_PACKET_COUNTER; ENQ_DISCARDED_PACKET_COUNTER; VOQ / VOQ connector; IPS_CR_BAL_TABLE
- Commands:
diag counters g,getreg,diag cosq print_flow_and_up,diag cosq voq,diag cosq qpair e2e,cosq conn ing,cosq conn egr,dump
Cisco Nexus 9000 Series NX-OS Programmability Guide, Release 10.1(x) – Broadcom Shell
- Link:
- Author:
Cisco
- Date:
2023-09-11
- Covers:
T2 instance selection
- Commands:
exit
Cisco Nexus 9000 Series NX-OS Programmability Guide, Release 6.x (chapter: Broadcom Shell)
- Link:
- Author:
Cisco
- Date:
2019-09-22
- Covers:
multiple units per line card or fabric module (T2 instances); instance wildcard ‘*’; accounting-log note: native shell commands are not logged
- Commands:
exit
Cisco Nexus 9000 Series NX-OS Programmability Guide, Release 7.x – Broadcom Shell
- Link:
- Author:
Cisco
- Date:
2025-01-13
- Covers:
unit prefix ‘1:’ and ‘*:’ in the wrapper; config vars (conf show/refresh/save/add/delete); l2_mem_entries; xe/hg port names; counter delta ‘+N’; DEFIP (LPM) vs L3 host table; multi-unit addressing (unit:cmd, * wildcard); typing a unit number switches unit; T2 (Trident 2) instances on line cards vs fabric modules (LPM on FM, hosts on LC); accounting-log behaviour
- Commands:
ports,conf ?,config show,l3 defip show,stg show,show counters,l3 l3table show,exit,config show l2_mem_entries,show counters xe0
Cisco Nexus 9000 Series NX-OS Troubleshooting Guide, Release 9.3(x) – Troubleshooting VLANs
- Link:
- Author:
Cisco
- Date:
2022-03-31
- Covers:
VXLAN tables VFI, MPLS_ENTRY (VXLAN_SIP), VLAN_XLATE (VXLAN_DIP), ING/EGR_L3_NEXT_HOP, ING_DVP_TABLE, EGR_DVP_ATTRIBUTE, EGR_IP_TUNNEL, EGR_PORT_TO_NHI_MAPPING; pbmp hex in vlan show; ipipe0 suffix; cpu0 port; dump chg on memories (VFI, MPLS_ENTRY, VLAN_XLATE, ING_DVP_TABLE, EGR_* next hop/tunnel); getreg chg; VXLAN encap/decap walk through Trident2 tables; multicast flood list index
- Commands:
stg show,vlan show,d chg,g chg,mc show,l2 show,l3 egress show,l3 multipath show,trunk show,phy info,show c,exit,d chg vfi 3,mc show 0x1803,d chg mpls_entry,d chg vlan_xlate,d chg ing_dvp_table 0x1751,d chg ing_l3_next_hop 0x18,g chg egr_port_to_nhi_mapping,d chg egr_ip_tunnel,d chg egr_dvp_attribute 0x1751,d chg egr_l3_next_hop 0x36,l3 multipath show 200264,show c cpu0
System Monitoring Command Reference for NCS 5500/540/560 – Traffic Monitoring Commands (show controllers fia diagshell)
- Link:
- Author:
Cisco
- Date:
PDF CreationDate 2026-09-11; command introduced in IOS XR 7.3.5
- Covers:
portmod PM types Pm4x25/Pm4x10/Pm4x10Q; phys vs logical port mapping; DNX (Jericho) shell
- Commands:
portmod info pm,diag counter nz
NCS5500: Life of a Packet (Transit, Punt/Inject, Ping Path)
- Link:
- Author:
Cisco TAC
- Date:
2021-08-02
- Covers:
cdsp counter view; punt/inject path
- Commands:
diag counters g
FTOS 8.3.16.4 Configuration Guide for the MXL 10/40GbE Switch IO Module
- Link:
- Author:
Dell Force10
- Date:
2013-03-13
- Covers:
bShell passthrough from vendor CLI
Dell Networking OS10 Routes are Not Installed (KB 000322394)
- Link:
- Author:
Dell Technologies
- Date:
2026-01-28
- Covers:
L3 host/route/nexthop/ECMP table capacity
- Commands:
l3 info,l3 defip show,l3 ip6route show
Open Networking Hardware Diagnostic Guide (May 2025)
- Link:
- Author:
Dell Technologies
- Date:
2025-05 (title); PDF CreationDate 2025-08-25
- Covers:
BCM.0> prompt; nputool built on sdk-6.5.3; BCM88375 (Qumran) probe output; nputool -i -t <test> -T ixia_self/ixia_adj -d; nputool sdk-6.5.3
- Commands:
ps,show c
Dell SmartFabric OS10 Installation, Upgrade, and Downgrade Guide (Appendix C/D: Upgrade PCIe firmware from DIAG OS / OS10 hshell)
- Link:
- Author:
Dell Technologies
- Date:
2022-10-14 (rev A13 last changed the hshell section); PDF CreationDate 2026-09-07
- Covers:
BCM56873_A0 / BCM56870_A0 driver (Trident 3) attach log; M0 firmware load linkscan_led_fw.bin / custom_led.bin; ‘Current mode is now ESW’; SAI.0> NPU shell prompt in OS10
- Commands:
pciephy fw load,exit,pwd,cd,ls
TroubleShooting Guide for the ARM platform via DIAG mode
- Link:
- Author:
Edgecore Networks (ann302_chung)
- Date:
2024-06-04
- Covers:
bcm.user banner (Broadcom Command Monitor, sdk-6.4.3 built 20160726, IPROC_CMICD, BCM56340_A0); ps output columns
- Commands:
ps
H3C S12500-F系列交换机 Probe命令参考(R100x系列)-6W100
- Link:
- Author:
H3C (New H3C Group)
- Language:
zh
- Covers:
vendor CLI wrapper for BCM shell; ‘/’ replaces spaces, ‘!’ for help; DNX diag cosq on DNX-based linecards
- Commands:
clear c,cos show,d chg egr_ip_tunnel,d dscp_table,d fp_counter_table,d fp_meter_table,d fp_tcam,d l3_tunnel,diag cosq print_flow_and_up,diag count packet nz,fp show entry,l3 defip show,l3 egress show,l3 intf show,l3 ip6host show,l3 ip6route show,l3 l3table show,l3 multipath show,show c,show c fabric,trunk show,stg info,vlan info
H3C S5830V2[S5820V2] Probe Command Reference – 01-Probe Commands
- Link:
- Author:
New H3C Technologies
- Date:
2014-07
- Covers:
‘/’ or ‘\’ replaces spaces, ‘!’ for help; per-chip addressing; FP TCAM/counter/meter tables; EGR_IP_TUNNEL
- Commands:
cos show,d chg,d dscp_table,d fp_counter_table,d fp_meter_table,d fp_tcam,d l3_tunnel,fp show entry,l3 defip show,l3 egress show,l3 intf show,l3 ip6host show,l3 ip6route show,l3 l3table show,l3 multipath show
Fastpath NOS CLI guide (§7.14 BCM Shell Command)
- Link:
https://netbergtw.com/wp-content/uploads/Files/Fastpath_cli_guide.pdf
- Author:
Netberg (Broadcom FASTPATH-derived text)
- Date:
2017-07-28
- Covers:
drivshell one-shot prefix; bcmsh interactive; management blocked while in shell
- Commands:
exit
Understanding the BFD Hardware Programming on NCS55xx and NCS5xx
- Link:
https://xrdocs.io/ncs5500/tutorials/understanding-the-bfd-hardware-programming-on-ncs55xx-and-ncs5xx
- Author:
Cisco engineers (xrdocs.io)
- Date:
2021-05-10
- Covers:
OAM endpoint id
- Commands:
diag oam ep
Other network operating systems and open-source projects
baseboxd knet_manager.cc
- Link:
- Author:
BISDN GmbH
- Date:
2026-10-05
- Covers:
KNET netif/filter lifecycle; /proc/bcm/knet/link
- Commands:
knet filter destroy <id>,knet netif destroy <id>
BISDN Linux bundle-debug-info support script
- Link:
- Author:
BISDN GmbH
- Covers:
techsupport bundles
- Commands:
ports,stg show,trunk show,techsupport basic
client_drivshell(8) man page
- Link:
- Author:
BISDN GmbH (Pierluigi Greto)
- Date:
2019-01-23
- Covers:
client_drivshell = ofdpaBcmCommand RPC passthrough to the BCM shell
BISDN Linux docs: OF-DPA client tools, auto-negotiation, FEC, SwitchControl, known issues
- Link:
https://github.com/bisdn/bisdn.github.io/tree/5b83beaaddfd9c003c071657a1d6633be1a19eff
- Author:
BISDN GmbH
- Covers:
Broadcom Shell / bcm-shell; rc.soc persistence (/etc/ofdpa/rc.soc, ends with exit); FEC cl74/cl91/cl108 via phy control; ports table output (ena/link, speed, autoneg, STP); SwitchControl
- Commands:
help,help <command>,ports,port xe0 an=on,port 2 enable=false,phy control 1,phy control 1 cl91=true,switchcontrol l3ucastttl1tocpu=1,switchcontrol l3ucastttl1tocpu
Cumulus Linux 2.1 Release Notes
- Link:
https://support.cumulusnetworks.com/hc/en-us/articles/202513093-Cumulus-Linux-2-1-Release-Notes
- Author:
Cumulus Networks
- Date:
circa 2014 (Cumulus 2.1 era; log excerpts dated 2013-12 and 2014-06); Wayback snapshot 2019-11-12
- Covers:
trunk port-selection criteria (rtag); HAL id ↔ trunk id mapping from switchd SIGRTMIN+5 dump; fp show entry/stat output
- Commands:
trunk psc id=1 rtag=0x3,fp show,fp stat get statid=93 type=packets
FBOSS: BcmSwitch gatherSdkState/rcload, validated shell commands, diag shell stress test, vendor-diag-shell skill, debugging doc
- Link:
https://github.com/facebook/fboss/tree/b9a907a45c7f8de43a7d0bce7026735acc32ca1e
- Author:
Meta (Facebook)
- Date:
files current at commit 2026-10-28
- Covers:
regex allow-list filter for diag commands; techsupport .soc scripts; SDK state dump at warm-boot shutdown; DNX vs XGS command differences
- Commands:
portstat,l2 show,l3 l3table show,l3 ip6host show,l3 defip show,l3 ip6route show,l3 intf show,l3 egress show,l3 multipath show,trunk show,rcload <file>,ps,show count,soc 0,show interrupts,xphy ver phy_id=0,xphy lw_dsc phy_id=0x40 if_side=1 lane_mask=0x11,quit,port status,debug soc counter debug,debug soc counter off,fp show,rcload <feature>.soc,version
FBOSS Broadcom agent (fboss/agent/hw/bcm): C++ code driving the bcm_* SDK API
- Link:
https://github.com/facebook/fboss/tree/422757d0014e3f08c40f83bd08f0645708cea3d3/fboss/agent/hw/bcm
- Author:
Meta (Facebook)
- Date:
2026-10-29
- Language:
C++
- Covers:
real-world bcm_* call sequences (L3 egress, ECMP, routes, ports, ACLs)
TestON OF-DPA switch driver
- Link:
- Author:
Open Networking Foundation (ONOS)
- Date:
2022-08-02
- Covers:
port speed abbreviation sp=
- Commands:
port <n> sp=<speed>
OpenSwitch ops-switchd-opennsl-plugin: ops-debug.c (ovs-appctl plugin/debug), ops-knet.c, ops-bcm-init.c
- Link:
- Author:
OpenSwitch project (HPE-led)
- Date:
2016-10-04
- Covers:
OpenNSL exposes the BCM shell via opennsl_driver_shell(); plugin/debug is OpenSwitch’s own BCM-style dump set, not the SDK shell
- Commands:
knet netif create ifname="eth_name" port=xen,knet filter create desttype=netif destid=xx striptag=yes desc=...
Stratum BcmDiagShell (telnet-served BCM diag shell) + standalone README + config.bcm
- Link:
https://github.com/stratum/stratum/tree/f8f71301cb602ac663818f2b185d57771b27d8e2/stratum/hal
- Author:
ONF / Google (Stratum)
- Covers:
diag shell served over telnet with stdin/stdout redirection; SDK6 (opennsa_diag) vs SDKLT shells; config.bcm properties (pbmp_xport_xe, l2_mem_entries, dport_map_*)
Stratum BcmSdkWrapper (stratum/hal/lib/bcm/sdk/bcm_sdk_wrapper.cc): bcm_* SDK API calls
- Link:
- Author:
ONF / Google (Stratum)
- Date:
2024-07-09
- Language:
C++
- Covers:
bcm_* call sequences for ports, L2, L3, field processor and packet I/O in one file
Community write-ups, cheat sheets, forums and blogs
BCM-SDK命令的使用.pdf
- Link:
- Author:
unknown Chinese OEM engineer (uploader yayasidak); example project DCNDS45XX (DCN)
- Date:
uploaded 2019-08-29 14:32:44
- Language:
zh
- Covers:
six command categories; register access; memory access; interrupt management; VLAN/L2/L3; mirroring; filtering; spanning tree group management; error-detection tests
- Commands:
??,?,help,version,show,port,combo,tx,packetwatcher,debug,debugmod,getreg,editreg,dump,write,intr,vlan,l2,l3,mirror,stg,test,config,flashinit,cpudb,ct
bcm cli 命令
- Link:
- Author:
枝桠 (cnblogs fallenmoon)
- Date:
2023-09-25
- Language:
zh
- Covers:
BCM56340 (Helix4); copper/fiber combo media; SerDes eyescan; packet watcher; OVS plugin wrapper
- Commands:
port,combo,s (setreg) xmac_pause_ctrl,pw log/report/start,phy diag eyescan,phy info,phy int,phy raw,pbmp,intr,sc igmppkttocpu,sea l2x,d chg,d vlan,dump pcic,show params,show int
BCM_SDK命令
- Link:
- Author:
SuperTao1024 (cnblogs)
- Date:
2016-02-02
- Language:
zh
- Covers:
full help listing (common vs current-mode commands); rate limiting; trunk rtag; I2C
- Commands:
?,portrate,trunk add,trunk show,i2c probe,i2c scan,i2c read,assert,background,bcm,bcmx,board,case,cd,config,console,copy,date,debug,debugmod,delay,device,dispatch,echo,exit,expr,flashinit,for,help,history,if,jobs,kill,local,log,loop,ls,mode,printenv,rccache,rcload,reboot,set,setenv,shell,sleep,time,version,age,attach,auth,bist,bpdu,cablediag,cache,combo,cos,counter,customstat,dma,dmirror,dscp,dump,editreg,fieldprocessor,getreg,gport,hash,headermode,init,insert,intr,ipfix,knetctrl,l2,l2mode,led,linkscan,listmem,listreg,lookup,mcast,memscan,memwatch,mirror,modify,modreg,packetwatcher,pbmp,phy
bcm cmd
- Link:
- Author:
yha) (cnblogs s08243)
- Date:
2016-12-29
- Covers:
pbm/ubm port bitmaps; multi-unit prompt BCM.1/BCM.2; register.port addressing (mac_ctrl.xe0); register vs memory command equivalence (Listreg<->LISTmem, Getreg<->Dump, Setreg<->Write/Insert, Modreg<->MODify); NVRAM config properties; switch controls; unit-wildcard commands
- Commands:
port,tx,ps,vlan create,vlan add,log,show c,combo,hm,packetwatcher,pw,listreg,l,getreg,g,g raw,g chg,listmem,dump,d,d all,d chg,setreg,modreg,modify,write,insert,list,show params,phy info,phy,dump pcic,switchcontrol,sc,config add/save/delete,link off,counter off,l2mode off,port ge en=0,tx 2 pbm=ge2,fe7,ps 0xf,ps ge3,port ge3,port 0xff an=1,port 4 ph=master|slave|auto,show c ge1,combo ge23,hm ieee,tx 10 pbm=ge0 length=100 sm=... dm=...,tx 10 pbm=ge0 file=pkt.hex,vlan create 97 pbm=ge2-ge5,vlan add 73 pbm=xe,hg,vlan create 85 pbm=... ubm=...,list vlan,d vlan,d all vlan,d chg vlan,d vlan 200 25,packetwatcher log 5 report +dec start,pw report -raw,log file=/tmp/x,log on|off,l mac,l mac_ctrl,g mac_ctrl.xe0,g raw mac_ctrl.xe3,g chg mac_ctrl.xe3,d chg l2x,phy ge7 3,phy ge5 0 0x8000,sc pbm=ge4 igmppkttocpu=1,config add counter_thread_pri=40,config phy_automedium_ge0.0=0,config save,config delete <name>
交换芯片Helix4 L2 L3功能验证
- Link:
- Author:
wallywl (cnblogs)
- Date:
2021-09-18
- Language:
zh
- Covers:
Helix4 (BCM5634x) L2/L3/QoS/ACL validation; KNET filters; port security; trunk hashing; route table flow; SDK init flow
- Commands:
ps,port,show c,clear c,vlan create/add/remove/destroy/show/default/multicastflood,pvlan,l2 add/del/show/clear/watch,age,l3 init,l3 intf,l3 egress,l3 defip,l3 l3table,mcast add/join/leave/delete,trunk init/add/remove/show,stg show,stg stp,bpdu add/show,auth init/mac/unblock,fp init/qset/group/entry/qual/action/show,cos show/port/drr/bandwidth_show,color map/unmap,dscp,d chg,d l2_user_entry,mod l2_user_entry,memwatch,sc arpreplytocpu,switchcontrol igmppkttocpu,knet filter create/show/destroy,dispatch linkreg,debug bcm,pbmp,dmir,cable
BCMShell使用说明简介 - 二层交换芯片调试接口
- Link:
https://blog.csdn.net/jiangbojacob/article/details/102977004
- Author:
jiangbojacob (CSDN)
- Date:
2019-11-08
- Language:
zh
- Covers:
case-insensitive commands; uppercase-letter abbreviation rule; OEM debug-hide entry
- Commands:
shell,exit
【交换芯片】硬件调测使用场景下的BMC交换常用命令说明
- Link:
- Author:
w952124796 (CSDN)
- Date:
2023-12-01
- Language:
zh
- Covers:
interface modes KR4/CR4/XFI/SFI; HiGig2 encapsulation; FEC via cint bcm_port_phy_control_set CL91; loopback
- Commands:
port speed/an/txpause/rxpause/en=force/lb=phy/if=/encap=higig2/vlanfilter,modreg xmac_ctrl line_remote_lpbk,cint,ps,vlan clear/destroy/remove/create/add/show,pvlan set/show
bcm 使用技巧
- Link:
https://blog.csdn.net/weixin_52130056/article/details/111316236
- Author:
weixin_52130056 (CSDN)
- Date:
2020-12-17
- Language:
zh
- Covers:
debug module levels; RDBGC drop counters / ING_EVENT_DEBUG / RDBGC0_SELECT; storm control
- Commands:
pwd,cd,log file= on,debug soc +/=,debug soc phy,debug show,getreg ing_event_debug,setreg,list,listr,d chg l2_entry,d chg vlan_profile,phy control,phy ge0 *,phy <port> <reg>,show unit,rate,ver
Access Broadcom Shell via Cumulus?
- Link:
https://forums.cumulusnetworks.com/cumulus-linux-230719/access-broadcom-shell-via-cumulus-7310233
- Author:
Cumulus community (Bryan Martin, Sean Cavanaugh [Cumulus], L S Makowski)
- Date:
2016-09-14 / 2017-05-05
- Covers:
bcmcmd wrapper exists in Cumulus 3.2.1; vendor position that direct shell access disrupts switchd
EdgeNOS: How Cumulus/switchd programs an ACL in the BCM56846 FP (+ raw fp show / FP_TCAM captures)
- Link:
https://github.com/wrightca1/edgenos/tree/15250c97ddd8aaae6bc212ad084137596f7fc788/docs
- Author:
wrightca1 (GitHub)
- Date:
capture 2026-07-05
- Covers:
fp show group/entry format (GID, qset, slice_pri/slice_sec, EID, Offset/Width/DATA/MASK, action); double-wide FP groups; FP_SLICE_MAP virtual vs physical slices; FPF1/2/3 selcodes
- Commands:
fp show,mirror show,d chg fp_tcam,d chg fp_policy_table,d chg fp_meter_table,g fp_slice_enable
Celestica E1031 LED bring-up notes
- Link:
https://github.com/quartzsystems/hemlock/blob/main/docs/e1031-led-bringup.md
- Author:
quartzsystems (GitHub)
- Date:
2026-08-23
- Covers:
LEDUP program RAM; led prog inline bytes
- Commands:
led status,led auto,led start,led stop,led prog,led dump
Disabled Interface Counters (J-Net forum thread)
- Link:
https://forums.juniper.net/t5/Junos/Disabled-Interface-Counters/td-p/463458
- Author:
Juniper community (J-Net); replies incl. Juniper staff
- Date:
2019-06
- Covers:
pbmp as hex (0x…1ffff…) and as list (xe0-xe48); HW (unit 0) output prefix; counter DMA
- Commands:
counter off,counter,counter portbitmap=,counter interval=
[j-nsp] Link establishment issues with 1Gbps SX/LX SFPs on QFX5110
- Link:
https://puck.nether.net/pipermail/juniper-nsp/2019-June/037439.html
- Author:
Shamen Snyder (ex-Juniper), juniper-nsp list
- Date:
2019-06-25
- Covers:
port <n> an=1 e=t attribute syntax; ps table columns (ena/link, speed/duplex, linkscan, autoneg, STP state, pause, discard, lrn ops, interface, max frame, loopback); ge0(45) logical/physical naming
- Commands:
ps,port
MPLS_cint脚本实现 (MPLS via CINT and diag commands)
- Link:
- Author:
lanpinguo (personal dev log)
- Date:
2014-09-18 (date in text); commit 2020-02-13
- Covers:
CINT interpreter inside the shell; gport encoding (0x800000b); SDK 6.6 vs 5.5 VPN id ranges (>=0x3000 vs 0x2000)
- Commands:
cint,cint_reset(),l3 intf add,l3 egress add,mpls init,mpls tunnel init set,mpls vpn create vpws,mpls vpn port add,mpls tunnel switch add,mpls tunnel l2 add,exit
Mininet-HiFi DCTCP experiment: hardware queue occupancy captures
- Link:
https://github.com/mininet/mininet-tests/tree/d8cb876d989efb029cf0472ef2ad4f3ee02d9b11/dctcp/hw_data
- Author:
Mininet project (Stanford)
- Date:
2012-01-27 (epoch timestamps in the capture); commit 2012-11-02
- Covers:
register.port indexing (reg(idx).port); getreg output format REG[addr]=val: <FIELD=…>; MMU queue occupancy polling
- Commands:
g op_queue_total_count_cell(0).ge1
PRBS testing on Broadcom (SONiC) — prbs_broadcom.md + README
- Link:
https://github.com/ManiAm/net-lab-prbs/blob/master/docs/prbs_broadcom.md
- Author:
ManiAm (GitHub)
- Date:
2026-05-30
- Covers:
phy diag prbs/prbsstat/berproj/dsc; PRBS polynomials; SAI not aware of shell changes
- Commands:
linkscan,phy prbs,phy diag,port,port prbs,port fecstat
Auto-MDIX / Flow Control wiki notes (Chinese)
- Link:
- Author:
nieyong (personal wiki)
- Date:
2014-03-11
- Covers:
MDIX(Auto, Xover) field in port status; IF(SGMII/GMII); QSGMII65 internal SerDes vs BCM53314 PHY in phy info
- Commands:
port ge14,ports,phy info,phy ge0,phy ge8
Juniper QFX5100 Series (Douglas Richard Hanks Jr., O’Reilly), Appendix A ‘Under the Hood’ – The Broadcom Shell / Broadcom Shell and cprod
- Link:
https://www.oreilly.com/library/view/juniper-qfx5100-series/9781491949566/app01.html
- Author:
Douglas Hanks (Juniper) / O’Reilly Media
- Date:
2014-11
- Covers:
tables vs views (L3_ENTRY vs L3_ENTRY_IPV4_UNICAST); register listing ‘listreg -s *’; CPU_CONTROL_1; ‘full docs need Broadcom NDA’ disclaimer
- Commands:
listmem,dump chg,listreg,getreg
OF-DPA with ONL Cheat Sheet
- Link:
- Author:
Phil Huang (pichuang)
- Date:
2017-01-04
- Covers:
BRCM Diag Shell via client_drivshell; linux-kernel-bde/linux-user-bde insmod
- Commands:
ps,port <n>,help,log f=/dev/console
Edgecore AS5610-52X reverse engineering: Cumulus 2.5 baseline captures
- Link:
- Author:
wrightca1 (GitHub)
- Date:
captures taken under Cumulus 2.5.0 (kernel built 2015-01-08; the switch RTC reads 2013, which is wrong); repo HEAD 2026-06-27
- Covers:
bcmcmd usage string ‘issue a single command to the diag shell via switchd’; full phy command help text (raw, dumpall c22/c45, control, prbs, margin, eee); pbmp in vlan show output; STG states; WC-B0 Warpcore phy mapping; cl-bcmcmd absent on 2.5
- Commands:
ps,phy,phy info,phy control xe0,phy diag xe0,vlan show,stg show,l2 show,l3 defip show,l3 ip6route show,l3 l3table show,l3 ip6host show,fp show,show counters,pmap,portmap
Talks and slide decks
BRKDCT-3101 Nexus 9000 (Standalone) Architecture and Troubleshooting
- Link:
- Author:
Shridhar V. Dhodapkar (Cisco), Cisco Live deck reposted on SlideShare
- Date:
2017-04
- Covers:
xe = front panel, hg = internal HiGig ports; unit prefix ‘0:’; programmable statistics counters (VLANDR)
- Commands:
show unit,ps,cstat,cstat info