TEAMDCTL(8)

💖 TEAMDCTL — the team daemon control tool 💖

okay bestie, so this is teamdctl from the teamd control section of the manual (section 8, system admin tools, iykyk). it's the little remote control for your team daemon and honestly? iconic.

✨ NAME ✨

teamdctl — team daemon control tool. that's it, that's the whole name, no notes 💅

🌸 SYNOPSIS 🌸

teamdctl [options] team_device command [command_args...]
teamdctl -h

so basically you hand it a team_device, a command, maybe some command_args, and she goes and does the thing. or you just do -h and she tells you about herself, main character energy.

🦋 DESCRIPTION 🦋

okay so teamdctl is the tool that lets you, a real human, talk to a running teamd instance. like sliding into its DMs but for network teaming. 🫶

by default it uses Unix Domain Sockets, but — and this is the slay part — it will fall back to using the D-Bus API so that operation stays reliable in literally all environments. versatile queen. 💖

🎀 OPTIONS 🎀

• -h, --help — prints the help text to your console and then dips. exit stage left. ✨
• -v, --verbosity — turns up the output verbosity. more words, more lore. 🔥
• -o, --oneline — forces the output onto one line if it possibly can. compact, cute, condensed. 🍓
• -D, --force-dbus — forces it to use the D-Bus interface. no fallback, no negotiation, just D-Bus. 💅
• -Z address, --force-zmq address — forces it to use the ZMQ interface. possible address formats include "tcp://ip:port", "ipc://path" and others. a detailed description of the ZMQ library lives at http://zguide.zeromq.org/page:all. ⭐
• -U, --force-usock — forces it to use the UNIX domain socket interface. fun fact: this is the default behaviour anyway, so it's giving "confirming what you already knew". 👑

👑 COMMAND 👑

this is the menu, bestie. pick your fighter.

• config dump — dumps the teamd JSON config. 🦋
• config dump noports — dumps the teamd JSON configuration without the "ports" section included. no ports, no problems. 🙈
• config dump actual — dumps the teamd actual JSON configuration. this one includes the ports that are currently present, so it's the real-time vibe check. ✨
• state dump | state — dumps the teamd JSON state document. two ways to say the same thing, we love options. 💜
• state view — prints out the state of teamd, parsed from the JSON state document. pretty version, we ate. 🎀
• state item get state_item_path — finds a state item inside the JSON state document and returns its value.

if PORTIFNAME inside state_item_path has any sensitive character, use double quotation marks to escape it, like: ports."eth1.1".link_watches.up. and processing the state_item_path of 'state item set' works exactly the same as here. 💅

• state item set state_item_path value — finds a state item inside the JSON state document and sets its value to the value parameter. this is available only for a limited number of paths:
  • setup.debug_level — you can set the debug level here. higher level is more verbose. 📢
  • ports.PORTIFNAME.runner.aggregator.selected — available for the lacp runner. you can manually select the aggregator. 🔥
  • runner.active_port — available for the activebackup runner. you can manually select the active port. 👑
• port add portdev — takes a port device name as its argument. adds that port device into the team. welcome to the group chat. 🫶
• port remove portdev — takes a port device name as its argument. removes that port device from the team. it's not you it's the config. 😭
• port present portdev — takes a port device name as its argument. checks whether the port device is present in the team. vibe check, basically. 🌈
• port config update portdev portconfig-string — takes the port device name as the first argument and a JSON-format configuration string as the second argument. updates the port device configuration. ✨
• port config dump portdev — takes the port device name as the first argument. dumps the port device JSON configuration to standard output. 💖

🌈 SEE ALSO 🌈

• teamd(8)
• teamnl(8)
• teamd.conf(5)

go read those too, they're the extended universe. ⭐

🌸 AUTHOR 🌸

Jiri Pirko is the original author and current maintainer of libteam. king behaviour, no cap. 👑

and that's the whole page, bestie! this one is from libteam, dated 2013-05-24 — vintage but still serving 💖✨🎀