Interfaces

The interfaces setting contains a list of settings for network interfaces. Each interface needs at least have an uniqure interface name.

Schema description

interfaces:
# list of interface settings
- name: eno1
  # ip addresses (ip address)
  addresses:
  - 192.0.2.254/24
  # link settings (ip link)
  link:
    state: up
    kind: physical
    businfo: 0000:00:1f.6

Examples:

• Bonding Interface w/ LACP (802.3ad)
• EoGRE Layer 2 Tunnel
• GENEVE Layer 2 Tunnel
• Physical Interface
• VLAN Subinterface (802.1q)
• VLAN Q-in-Q Subinterfaces (802.1ad + 802.1q)

The link setting defines the type and states of the interfaces. In contrast to virtual interfaces, physical interfaces cannot be created or destroyed. It is therefore important that physical interfaces can be uniquely identified. IfState provides the following properties to uniquely identify an interface (in order of priority):

1. link.businfo - the PCI or USB bus address
2. link.permaddr - the built-in permanent mac address
3. link.address - the mac address
4. name - the interface name

The properties businfo and permaddr cannot be changed in Linux and are therefore the most reliable identifiers.

Other settings available for an inteface:

• addresses - assigned ip addresses
• brport - bridge port specific settings
• fdb - permanent bridge forwarding database entries
• vrrp - VRRP action conditions
• link - link settings
• neighbours - permanent ip neighbour cache entries
• sysctl - interface specific procfs settings
• ethtool - ethtool settings
• cshaper - simplified tc settings ("cake shaper")
• tc - traffic control settings
• wireguard - wireguard configuration and peers
• xdp - assign eXpress Data Path BPF programs