| MCTL(8) | System Manager's Manual (smm) | MCTL(8) |
NAME
mctl —
status tool for
mcd(8)
SYNOPSIS
mctl |
[-hmptv-i
NAME-u
FILECOMMAND ] |
DESCRIPTION
mctl queries a running
mcd(8) over its IPC
socket and shows the queriers, the group memberships and the multicast state
of the bridge. Without a command it runs
show.
Most bridge state comes from the iproute2 tools
ip(8) and
bridge(8), and from
jq(1). Their BusyBox
versions are not enough, use check to
confirm.
OPTIONS
-h,--help- Show usage and, when
mcdis running, the available commands. -i,--ident=NAME- Talk to an
mcdstarted with the same-iNAME. -m,--monitor- Run the command every two seconds, like watch(1).
-p,--plain- Plain table headings, no terminal control characters. Implied for JSON output.
-t,--no-heading- Skip table headings.
-u,--ipc=FILE- IPC socket, default derived from the identity. Also settable with the
MCD_SOCKenvironment variable. -v,--version- Show version and exit.
COMMANDS
Commands can be abbreviated, e.g.s i for
show interfaces. Adding
json to a
show command gives machine readable output.
show[] [igmp]json- Overview: global settings, bridge port roles, the queriers and the group memberships. In JSON the queriers are split in “multicast-queriers” for IGMP and “mld-queriers” for MLD.
show status[]json- Global settings.
show interfaces[]json- One row per interface and protocol: VLAN, protocol, elected querier, state, query interval, querier timeout and protocol version.
show groups[]json- IGMP and MLD group memberships, as seen by the bridge.
show router-ports[]json- Multicast router ports, grouped per bridge.
show mdb- The bridge multicast forwarding database, as
‘
bridge mdb show’ but readable. check- Verify that the tools listed above are available.
version- Show the version of the running
mcd. help- List the commands the running
mcdsupports.
ENVIRONMENT
MCD_SOCK- IPC socket path, overridden by
-u.
FILES
- /run/mcd.sock
- Default IPC socket, follows the identity. The group owner is set at build
time, see ‘
configure --with-group’.
EXAMPLES
$ mctl show interfaces Interface VID Proto Querier State Interval Timeout Ver vlan1 IGMP 192.168.1.1 Up 125 None 3 vlan1 MLD fe80::7a4c:9bff:fe12:3456 Up 125 None 2 br0 42 IGMP 0.0.0.0 Up 125 None 3 br0 42 MLD :: Up 125 None 2
echo "show igmp json" | socat - UNIX-CONNECT:/run/mcd.sock
SEE ALSO
mcd.conf(5), mcd(8)AUTHORS
mctl is maintained by
Joachim Wiberg,
Tobias Waldekranz and the KernelKit team,
https://kernelkit.org.
See mcd(8) for its
history.| October 16, 2026 | Debian |
Maintained in kernelkit/mcd as man/mctl.8. Send corrections there, or read it on the mirror.