NAME

bootbridgectl — inspect and steer a running bootbridge

SYNOPSIS

DESCRIPTION

bootbridgectl talks to the control socket of a bootbridge(8) that is running, on the same machine: it reports the interfaces it bridges and the peers it knows, prints statistics and the frames that pass through, and changes what bootbridge(8) prints while it runs. Every command prints one line of JSON the bridge sends; -json passes those lines through unchanged, for jq(1).

The socket is -ctl of bootbridge(8): /run/bootbridge/bootbridge.sock when it runs as root (or /var/run/bootbridge/bootbridge.sock), where there is no Pa /run , a per-user socket under XDG_RUNTIME_DIR or /tmp otherwise. With several bridges on one machine, give bootbridgectl -socket the path bootbridge(8) logged when it started. BOOTBRIDGE_CTL_SOCKET is the default when no -socket is given. Anyone who can write the socket sees every frame bridged and can change what is printed.

The commands are:

status

The bridge's version, uptime, configuration file, interface, MAC, socket path, and packet printing settings.

peers [-i name]

The UDP peers of every transport: the configured ones, the ones learned from the frames they sent, when each was last heard from, and which Ethernet addresses were learned from each. With the LAN side, the hosts seen there with their IP addresses. -i limits the output to one side, lan or udp, or to one transport by name.

stats [-w]

Packets, bytes and errors per side, once, or every second with -w.

tail [-n count]

The last count frames the bridge forwarded, 20 by default, 0 for all it remembers.

tail [-t count] -f

The remembered frames again, then every new one until interrupted; -t says how many to replay (50 by default) and -n stops after that many.

log [-i name] [-n count] [-t count]

Every frame as it passes, like bootbridge(8) -print.

dump [-i name] [-n count] [-t count]

The same with a hex and ASCII dump of each frame, like bootbridge(8) -X.

set [-print on|off] [-dump on|off] [-iface name]

Change what bootbridge(8) prints to its own terminal, as its single keys do, and print the new settings.

All commands take -socket path and -json.

A streaming command stops when the terminal interrupts it, when bootbridge(8) stops, or when -n frames have been printed.

EXIT STATUS

bootbridgectl exits 0 on success, 1 if the socket cannot be reached or the bridge reports an error, and 2 for invalid usage.

EXAMPLES

Ask a bridge started as a service what it knows:

Watch a client boot, remembering what passed before you started:

Follow the frames of one side and count them:

Turn on the bridge's own packet printing for the LAN side:

Script it:

SEE ALSO

jq(1), bootbridge(8)