nmstate-autoconf(8)

πŸ’… NAME πŸ’…

okay so bestie, gather round β€” nmstate-autoconf is the nmstate command line tool that just automatically configures your network state using LLDP information. no cap, it does the whole thing for you ✨ (this manual page is nmstate-autoconf(8) btw, iykyk πŸŽ€)


🌸 SYNOPSIS 🌸

nmstate-autoconf [INTERFACE_NAME] [--dry-run]

πŸ¦‹ DESCRIPTION πŸ¦‹

nmstate-autoconf is a command line tool that uses libnmstate in order to configure the network state automatically using LLDP information. it's giving "experimental era" though β€” this tool is experimental only, no cap πŸ’€

so what happens? nmstate-autoconf will identify the interfaces connected to a VLAN and unify them in a bond interface. then, on top of that, a vlan interface gets created. two-for-one, iconic πŸ‘‘

the bond state will be the following one:

- name: bond50
  type: bond
  state: up
  link-aggregation:
    mode: balance-rr
    port:
    - enp4s0
    - enp4s0d1

and the host VLAN state will be the following one:

- name: prod-net
  type: vlan
  state: up
  vlan:
    base-iface: bond50
    id: 50

see? slay. 🫢

now, for multiple interface names, use a comma to separate them. you can also use patterns for interface names:

  • * matches everything
  • ? matches any single character
  • [seq] matches any character in seq
  • [!seq] matches any character not in seq

for example, to enable LLDP auto configuration on all interfaces starts with eth:

nmstate-autoconf eth\*
# The backslash is required to stop shell expanding '*' to file
# names.
⚠️ yes the backslash is doing real work there β€” it stops your shell from expanding * to file names. don't skip it bestie 😭

✨ OPTIONS ✨

  • --dry-run, -d β€” generate the network state that is going to be applied and print it out. it won't apply any changes in the host πŸ™ˆ literally just a vibe check before the real thing.

🌈 LIMITATIONS 🌈

  • this tool is experimental only πŸ’€
  • it is not possible to configure automatically bond or vlan options. not me finding out the limits πŸ˜”

πŸ› BUG REPORTS πŸ›

report bugs on nmstate GitHub issues <https://github.com/nmstate/nmstate>. fr fr, that's the spot πŸ“


license Apache-2.0 <https://www.apache.org/licenses/LICENSE-2.0> β€” iconic legally-mandated behavior πŸ’œ


πŸ’– SEE ALSO πŸ’–


okay that's the whole page bestie! πŸŽ€ this was nmstate-autoconf from version 2.2.62, dated October 16, 2026 β€” go forth and auto-configure, you absolute main character πŸŒŸπŸ’…

πŸ“¦ where this page comes from