Skip to content

vyos_interface

Experimental. The settings Conn3x owns on one VyOS interface: description, addresses, enabled and MTU. Each one left unset is left alone, and so is every other statement under the interface.

Experimental. Network devices are new, and this module may change between releases. It’s tested against VyOS 2026.11.13-0016-rolling in a container on a lab VM, not yet in CI.

Use vyos_interface to own a few settings on one VyOS interface: its description, its addresses, whether it’s enabled, and its MTU. Every setting you leave unset is left alone, and so is everything else under the interface. The change goes in like every VyOS step does, once per router per circuit; see vyos_config.

addresses is the interface’s whole set: an address that isn’t listed is deleted. Two guards keep Conn3x from cutting itself off. It won’t take off the address it connects to, and it won’t disable the interface that holds it.

step "lan" {
vyos_interface {
name = "eth1"
description = "lan"
addresses = ["192.168.10.1/24"]
mtu = 1500
}
}
Name Type Required Description
addresses list of string No Its whole set of addresses, each with its prefix length, such as 192.0.2.1/24, or dhcp or dhcpv6. Addresses not listed are deleted; taking off the one Conn3x connects to is refused.
description string No Its description. No quotes or backslashes.
enabled bool No false sets disable, true deletes it. Disabling the interface whose address Conn3x connects to is refused.
mtu number No MTU, 68 to 16000.
name string Yes The interface, such as eth0, bond0, br0, wg0 or lo.
on_remove string No What happens when this resource is removed: “forget” (default) leaves the interface as it is, “delete” deletes the statements it owns. The interface itself stays.

Conn3x sets these; reference them as conn3x_vyos_interface.<circuit>__<step>["<host>"].<name>.

Name Type Description
in_sync bool Whether the interface had these settings at the last refresh.
revision string Changes each time Conn3x changes this on the host. Handlers watch it.

A step lowers to the conn3x_vyos_interface resource, one instance per host, and connects with its circuit’s ssh block.