IFCFG-VXLAN(5)

NAME
ifcfg-vxlan - Virtual eXtended LAN interface configuration

SYNOPSIS
/etc/sysconfig/network/ifcfg-*

VXLANs
To setup a vxlan interface, you need a configuration file that contains the following variable set to yes:

VXLAN { yes | no }

It may contain also the following options:

VXLAN_ID { 0..16777215 }
    Specifies the VXLAN Network Identifier (Segment Identifier).

VXLAN_DEVICE { <name> }
    Specifies the link device name to use for tunnel endpoint communication.

VXLAN_REMOTE_IP { <IPv4> | <IPv6> }
    Specifies the unicast or multicast destination IP address. A multicast address requires a link device in via VXLAN_DEVICE.

VXLAN_LOCAL_IP  { <IPv4> | <IPv6> }
    Specifies source IP address to use in outgoing packets.

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.

VXLAN_SRC_PORT_LOW  { 0..65535 }

VXLAN_SRC_PORT_HIGH  { 0..65535 }
    The UDP source port range to use in communication with tunnel endpoint.

VXLAN_TTL { 0..255 }
    The TTL aka hop-limit for to use in outgoing packets.

VXLAN_TOS { 0..255 }
    The TOS to set in outgoing packets.

VXLAN_AGEING { 0 | <secs> }
    Lifetime in seconds of the FDB entries in the kernel.

VXLAN_MAX_ADDRS { 0 | <max> }
    Maximal number of addresses/entries in the FDB.

VXLAN_LEARNING { yes | no }
    Disables to not learn unknown source link layer address.

VXLAN_PROXY { yes | no }
    Enables ARP/NDP proxy.

VXLAN_RSC { yes | no }
    Enables route short circuit.

VXLAN_L2MISS { yes | no }
    Enables netlink link-layer address miss notification generation.

VXLAN_L3MISS { yes | no }
    Enables netlink ip address miss notification generation.

VXLAN_UDP_CSUM { yes | no }
    Enables to calculate UDP checksums.

VXLAN_UDP6_ZERO_CSUM_TX  { yes | no }
    Enables to calculate UDP checksums.

VXLAN_UDP6_ZERO_CSUM_RX  { yes | no }
    Specified if UDP checksums are received.

VXLAN_REM_CSUM_TX  { yes | no }
    Enables/disables transmit checksum offloading.

VXLAN_REM_CSUM_RX  { yes | no }
    Enables/disables receive checksum offloading.

VXLAN_REM_CSUM_PARTIAL  { yes | no }
    Disables partial gro checksum handling.

VXLAN_COLLECT_METADATA  { yes | no }
    Whether to collect metadata on external control plane of internal FDB.

VXLAN_GBP  { yes | no }
    Enables Group Policy extension.

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'. 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.

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
Copyright (C) 2017 SUSE LINUX, Nuernberg, Germany.

BUGS
Please report bugs as described at <https://bugs.opensuse.org>

AUTHORS
Marius Tomaschewski

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