IFCFG-VXLAN(5)

📦 version 0.6.80, in opensuse-leap 16.0

IFCFG-VXLAN(5) — Virtual eXtended LAN interface configuration 🦋✨

Okay bestie, gather round 💅 because we're about to talk about ifcfg-vxlan, the manual page that teaches you how to set up a Virtual eXtended LAN interface. No cap, this is the glow-up your network config deserves.

✨ NAME ✨

ifcfg-vxlan — Virtual eXtended LAN interface configuration 🎀

🌸 SYNOPSIS 🌸

/etc/sysconfig/network/ifcfg-*

🧚 VXLANs 🧚

So to set up a vxlan interface, you literally need a configuration file that contains the following variable set to yes. It's giving main character energy:

  • VXLAN { yes | no } — Set this to yes and you're in business, bestie. 💖

It may also contain the following options. Obsessed with the customization:

  • VXLAN_ID { 0..16777215 } — Specifies the VXLAN Network Identifier (Segment Identifier). Like a little ID card for your segment. 🪪
  • VXLAN_DEVICE { <name> } — Specifies the link device name to use for tunnel endpoint communication. Basically, which network buddy is carrying the tunnel vibes. 🫶
  • VXLAN_REMOTE_IP { <IPv4> | <IPv6> } — Specifies the unicast or multicast destination IP address. A multicast address requires a link device in via VXLAN_DEVICE. Lowkey important: multicast needs that link device, okay? 😭
  • VXLAN_LOCAL_IP { <IPv4> | <IPv6> } — Specifies source IP address to use in outgoing packets. Your outgoing packet's origin story. ✨
  • VXLAN_DST_PORT { 0..65535 } — The UDP destination port of the remote tunnel endpoint. IANA assigned port is 4789 while the linux kernel is using port 8472. Not me remembering both 😭
  • VXLAN_SRC_PORT_LOW { 0..65535 } — The low end of the UDP source port range to use in communication with tunnel endpoint. 🍓
  • VXLAN_SRC_PORT_HIGH { 0..65535 } — The high end of the UDP source port range to use in communication with tunnel endpoint. Together with the low one, they're giving range. 💅
  • VXLAN_TTL { 0..255 } — The TTL aka hop-limit for to use in outgoing packets. Keep those packets from living forever. 💀
  • VXLAN_TOS { 0..255 } — The TOS to set in outgoing packets. Type of service, not type of slay. 🌈
  • VXLAN_AGEING { 0 | <secs> } — Lifetime in seconds of the FDB entries in the kernel. Let them age gracefully. 🎀
  • VXLAN_MAX_ADDRS { 0 | <max> } — Maximal number of addresses/entries in the FDB. Cap the guest list. 👑
  • VXLAN_LEARNING { yes | no } — Disables to not learn unknown source link layer address. Yes, the double negative is in the original, bestie. I don't make the rules. 🙈
  • VXLAN_PROXY { yes | no } — Enables ARP/NDP proxy. Acting on behalf of others, iconic. ⭐
  • VXLAN_RSC { yes | no } — Enables route short circuit. Taking the shortcut, we love efficiency. 🔥
  • VXLAN_L2MISS { yes | no } — Enables netlink link-layer address miss notification generation. It's giving "hey I didn't find that" energy. 📣
  • VXLAN_L3MISS { yes | no } — Enables netlink ip address miss notification generation. Same but for IP addresses. 💌
  • VXLAN_UDP_CSUM { yes | no } — Enables to calculate UDP checksums. Checksums are the vibe check for your packets. ✅
  • VXLAN_UDP6_ZERO_CSUM_TX { yes | no } — Enables to calculate UDP checksums. (Yes, the original says the same thing here, I'm just the messenger bestie 😭)
  • VXLAN_UDP6_ZERO_CSUM_RX { yes | no } — Specified if UDP checksums are received. On the receiving end of things. 🫶
  • VXLAN_REM_CSUM_TX { yes | no } — Enables/disables transmit checksum offloading. Offload that work, periodt. 💅
  • VXLAN_REM_CSUM_RX { yes | no } — Enables/disables receive checksum offloading. Receiving the offloaded vibes. 🌸
  • VXLAN_REM_CSUM_PARTIAL { yes | no } — Disables partial gro checksum handling. Note: disables, not enables. Read carefully bestie. 🧚
  • VXLAN_COLLECT_METADATA { yes | no } — Whether to collect metadata on external control plane of internal FDB. Metadata collection is very main character. 🦋
  • VXLAN_GBP { yes | no } — Enables Group Policy extension. Group policy but make it fashion. 💜

An ifcfg- file for the interface specified by VXLAN_DEVICE must also be provided. In the most basic case, it should at least contain STARTMODE='auto'. Don't skip this step, bestie, it's literally required. 😤

The rest of the VXLAN interface IP and routes configuration do not differ from ordinary interfaces. See also man ifcfg and man routes for details. We stan consistency. ✨

💖 EXAMPLES 💖

Sets up vxlan0 vxlan interface on top of eth0:

ifcfg-vxlan0
   STARTMODE='auto'
   VXLAN='yes'
   IPADDR='192.168.3.27/24'

Sets up vxlan0 vxlan interface with an ID/VNI 1 and linked to the eth0 device:

ifcfg-vxlan0
   STARTMODE='auto'
   VXLAN='yes'
   VXLAN_DEVICE='eth0'

Copyright (C) 2017 SUSE LINUX, Nuernberg, Germany.

💀 BUGS 💀

Please report bugs as described at <https://bugs.opensuse.org>. Don't suffer in silence, bestie. 🫶

🌟 AUTHORS 🌟

Marius Tomaschewski — the icon who made this possible. 💅

🔥 SEE ALSO 🔥

ifcfg(5), routes(5), wicked(8).

This page is from wicked, April 2017, and it's still serving looks. Stay config'd, bestie. 🎀✨
📦 where this page comes from