kpfleming.systemd_networkd.tunnel role – Manages systemd-networkd tunnel virtual network devices.

Note

This role is part of the kpfleming.systemd_networkd collection (version 25.9.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install kpfleming.systemd_networkd.

To use it in a playbook, specify: kpfleming.systemd_networkd.tunnel.

Entry point main – Manages systemd-networkd tunnel virtual network devices.

Synopsis

  • This role will create (or update) three items in /etc/systemd/network for each specified tunnel: 1) A drop-in directory for the underlying network 2) A .netdev file for the tunnel device 3) A .conf file in the drop-in directory connecting the tunnel device to the underlying network

  • Detailed descriptions of parameters and their behavior can be found in ‘man systemd.netdev’.

  • Sets fact named ‘systemd_networkd_tunnel_changed’ to either true or false to indicate whether any changes were made.

Parameters

Parameter

Comments

suppress_reload

boolean

Suppress the reloading of systemd-networkd if changes are made.

Choices:

  • false ← (default)

  • true

systemd_root

string

Root path of filesystem containing systemd-networkd configuration files.

Default: ""

tunnels

list / elements=dictionary / required

Attributes of the tunnels to be managed.

match

dictionary

Matching attributes of the network device.

system

dictionary

System-specific attributes to be matched.

architecture

string

Match system architecture.

credential

string

Match service credential.

firmware

string

Match system firmware.

host

string

Match hostname or machine ID.

kernel_command_line

string

Match kernel command line option presence.

kernel_version

string

Match kernel version expression.

virtualization

string

Match virtualization type.

name

string / required

Name of the tunnel device.

netdev

dictionary

Attributes of the tunnel network device.

mac_address

string

MAC address to use on the device.

mtu_bytes

string

The MTU for the device.

tunnel

dictionary

Attributes of the tunnel device.

input_key

string

Tunnel key to use for input traffic if using VTI/VTI6, GRE, GRETAP or ERSPAN tunnel. Must be an integer or an IPv4 address-like dotted quad.

key

string

Tunnel key to use in both directions (input and output) if using VTI/VTI6, GRE, GRETAP or ERSPAN tunnel. Must be an integer or an IPv4 address-like dotted quad.

kind

string / required

Type of tunnel.

Choices:

  • "gre"

  • "gretap"

  • "ip6gre"

  • "ip6tnl"

  • "ip6gretap"

  • "ipip"

  • "sit"

  • "vti"

  • "vti6"

local

string

Local address for tunneled packets.

output_key

string

Tunnel key to use for output traffic if using VTI/VTI6, GRE, GRETAP or ERSPAN tunnel. Must be an integer or an IPv4 address-like dotted quad.

remote

string

Remote address for tunneled packets.

ttl

integer

Time-To-Live for tunneled packets.

underlying_name

string / required

The underlying network.