.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "interfaces-vxlan" "5" "2022-10-15"
.P
.SH NAME
.P
\fBinterfaces-vxlan\fR - VXLAN extensions for the interfaces(5) file format
.P
.SH DESCRIPTION
.P
Virtual eXtensible LAN (VXLAN) is an overlay network to carry Layer 2 over
an IP network while accommodating a very large number of tenants.\& It is
defined in RFC 7348.\&
.P
Be aware that VXLAN encapsulation adds 50 bytes of overhead to the IP packet
header (inner Ethernet header + VXLAN + UDP + IP).\& This should be taken into
consideration when setting up overlay networks, particularly on underlay
networks with a conventional 1500 byte MTU.\&
.P
The following options set up VXLAN Tunnel EndPoints (VTEP) interfaces with
ifupdown-ng.\&
.P
See https://www.\&kernel.\&org/doc/Documentation/networking/vxlan.\&rst and
https://vincent.\&bernat.\&ch/en/blog/2017-vxlan-linux for more information.\&
.P
.SH VXLAN-RELATED OPTIONS
.P
A VXLAN Virtual Tunnel Endpoint (VTEP) interface must an ID set.\& All
other options are optional.\&
.P
\fBvxlan-id\fR \fIVNI ID\fR
.RS 4
Denotes the VXLAN Network Identifier (VNI) ID for this interface.\&
This parameter is required for VTEP interfaces.\&
.P
.RE
\fBvxlan-physdev\fR \fIinterface\fR
.RS 4
Specifies the physical ("underlay") device to use for tunnel
endpoint communication.\&
.P
.RE
\fBvxlan-local-ip\fR \fIaddress\fR
.RS 4
Specifies the source IP address to use in outgoing packets.\&
For compatiblity with ifupdown2 \fIvxlan-local-tunnelip\fR is an
alias for this parameter.\&
.P
.RE
\fBvxlan-remote-ip\fR \fIaddress\fR
.RS 4
Specifies the unicast destination IP address to use in outgoing
packets when the destination link layer address is not known in
the VXLAN device forwarding database.\& This parameter cannot be
specified with the \fIvxlan-remote-group\fR parameter.\&
For compatiblity with ifupdown2 \fIvxlan-remoteip\fR is an alias for
this parameter.\&
.P
.RE
\fBvxlan-remote-group\fR \fImulticast group\fR
.RS 4
Specifies the multicast group IP address to join.\& This parameter
cannot be specified with the \fIvxlan-remote-ip\fR parameter.\&
For compatibility with ifupdown2 \fIvxlan-svcnodeip\fR is an alias for
this parameter.\&
.P
.RE
\fBvxlan-learning\fR \fIon/off\fR
.RS 4
Specifies if unknown source link layer addresses and IP addresses
are entered into the VXLAN device forwarding database.\&
.P
.RE
\fBvxlan-ageing\fR \fIseconds\fR
.RS 4
Specifies the lifetime in seconds of FDB entries learnt by the kernel.\&
.P
.RE
\fBvxlan-dstport\fR \fIport\fR
.RS 4
Specifies the UDP destination port of the remote VXLAN tunnel endpoint.\&
The default is 4789.\&
.P
.RE
.SH EXAMPLES
.P
A VTEP with multiple peers addressed via a multicast group:
.P
.nf
.RS 4
auto vx_v1001_padcty
iface vx_v1001_padcty
	vxlan-id           655617
	vxlan-physdev	   vlan1001
	vxlan-remote-group 225\&.10\&.1\&.1
	#
	hwaddress f2:00:c1:01:10:01
	mtu 1560
.fi
.RE
.P
Note that the underlay must have an MTU of at least 1610 to
carry the encapsulated packets.\&
.P
.P
A VTEP with one peer (point-to-point configuration):
.P
.nf
.RS 4
auto vx_ptp1
iface vx_ptp1
	vxlan-id        2342
	vxlan-local-ip  192\&.0\&.2\&.42
	vxlan-remote-ip 198\&.51\&.100\&.23
	#
	hwaddress f2:00:c1:01:10:01
.fi
.RE
.P
.SH AUTHORS
.P
Maximilian Wilhelm <max@sdn.\&clinic>