Skip to content

vyos_hostname

Experimental. A VyOS router’s host name. Removing this step leaves the name as it is.

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_hostname to name a VyOS router. The change goes in like every VyOS step does: a dry run, commit-confirm, then a confirm and save over a new login, once per router per circuit. See vyos_config.

step "name" {
vyos_hostname {
name = each.key
}
}
Name Type Required Description
name string Yes Host name, such as r1. VyOS takes letters, digits and hyphens.

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

Name Type Description
in_sync bool Whether the router had this name 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_hostname resource, one instance per host, and connects with its circuit’s ssh block.