summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/vxlan.4 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
commit1f19f33e45791ea59aed048796fc68672c6723a5 (patch)
tree54625fba89e91d1c2177801ec635e8528bba937f /static/freebsd/man4/vxlan.4 3.html
parentac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (diff)
docs: Removed Precompiled HTML
Diffstat (limited to 'static/freebsd/man4/vxlan.4 3.html')
-rw-r--r--static/freebsd/man4/vxlan.4 3.html180
1 files changed, 0 insertions, 180 deletions
diff --git a/static/freebsd/man4/vxlan.4 3.html b/static/freebsd/man4/vxlan.4 3.html
deleted file mode 100644
index 7c0dfb8d..00000000
--- a/static/freebsd/man4/vxlan.4 3.html
+++ /dev/null
@@ -1,180 +0,0 @@
-<table class="head">
- <tr>
- <td class="head-ltitle">VXLAN(4)</td>
- <td class="head-vol">Device Drivers Manual</td>
- <td class="head-rtitle">VXLAN(4)</td>
- </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<p class="Pp"><code class="Nm">vxlan</code> &#x2014; <span class="Nd">Virtual
- eXtensible LAN interface</span></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<p class="Pp">To compile this driver into the kernel, place the following line
- in your kernel configuration file:</p>
-<div class="Bd Pp Bd-indent"><code class="Cd">device vxlan</code></div>
-<p class="Pp">Alternatively, to load the driver as a module at boot time, place
- the following line in <a class="Xr">loader.conf(5)</a>:</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>if_vxlan_load=&quot;YES&quot;</pre>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-<p class="Pp">The <code class="Nm">vxlan</code> driver creates a virtual tunnel
- endpoint in a <code class="Nm">vxlan</code> segment. A
- <code class="Nm">vxlan</code> segment is a virtual Layer 2 (Ethernet)
- network that is overlaid in a Layer 3 (IP/UDP) network.
- <code class="Nm">vxlan</code> is analogous to <a class="Xr">vlan(4)</a> but
- is designed to be better suited for large, multiple tenant data center
- environments.</p>
-<p class="Pp">Each <code class="Nm">vxlan</code> interface is created at runtime
- using interface cloning. This is most easily done with the
- <a class="Xr">ifconfig(8)</a> <code class="Cm">create</code> command or
- using the <var class="Va">cloned_interfaces</var> variable in
- <a class="Xr">rc.conf(5)</a>. The interface may be removed with the
- <a class="Xr">ifconfig(8)</a> <code class="Cm">destroy</code> command.</p>
-<p class="Pp">The <code class="Nm">vxlan</code> driver creates a pseudo Ethernet
- network interface that supports the usual network
- <a class="Xr">ioctl(2)</a>s and thus can be used with
- <a class="Xr">ifconfig(8)</a> like any other Ethernet interface. The
- <code class="Nm">vxlan</code> interface encapsulates the Ethernet frame by
- prepending IP/UDP and <code class="Nm">vxlan</code> headers. Thus, the
- encapsulated (inner) frame is able to be transmitted over a routed, Layer 3
- network to the remote host.</p>
-<p class="Pp">The <code class="Nm">vxlan</code> interface may be configured in
- either unicast or multicast mode. When in unicast mode, the interface
- creates a tunnel to a single remote host, and all traffic is transmitted to
- that host. When in multicast mode, the interface joins an IP multicast
- group, and receives packets sent to the group address, and transmits packets
- to either the multicast group address, or directly to the remote host if
- there is an appropriate forwarding table entry.</p>
-<p class="Pp">When the <code class="Nm">vxlan</code> interface is brought up, a
- <a class="Xr">udp(4)</a> <a class="Xr">socket(9)</a> is created based on the
- configuration, such as the local address for unicast mode or the group
- address for multicast mode, and the listening (local) port number. Since
- multiple <code class="Nm">vxlan</code> interfaces may be created that either
- use the same local address or join the same group address, and use the same
- port, the driver may share a socket among multiple interfaces. However, each
- interface within a socket must belong to a unique
- <code class="Nm">vxlan</code> segment. The analogous
- <a class="Xr">vlan(4)</a> configuration would be a physical interface
- configured as the parent device for multiple VLAN interfaces, each with a
- unique VLAN tag. Each <code class="Nm">vxlan</code> segment is identified by
- a 24-bit value in the <code class="Nm">vxlan</code> header called the
- &#x201C;VXLAN Network Identifier&#x201D;, or VNI.</p>
-<p class="Pp">When configured with the <a class="Xr">ifconfig(8)</a>
- <code class="Cm">vxlanlearn</code> parameter, the interface dynamically
- creates forwarding table entries from received packets. An entry in the
- forwarding table maps the inner source MAC address to the outer remote IP
- address. During transmit, the interface attempts to lookup an entry for the
- encapsulated destination MAC address. If an entry is found, the IP address
- in the entry is used to directly transmit the encapsulated frame to the
- destination. Otherwise, when configured in multicast mode, the interface
- must flood the frame to all hosts in the group. The maximum number of
- entries in the table is configurable with the <a class="Xr">ifconfig(8)</a>
- <code class="Cm">vxlanmaxaddr</code> command. Stale entries in the table are
- periodically pruned. The timeout is configurable with the
- <a class="Xr">ifconfig(8)</a> <code class="Cm">vxlantimeout</code> command.
- The table may be viewed with the <a class="Xr">sysctl(8)</a>
- <code class="Cm">net.link.vxlan.N.ftable.dump</code> command.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="MTU"><a class="permalink" href="#MTU">MTU</a></h1>
-<p class="Pp">Since the <code class="Nm">vxlan</code> interface encapsulates the
- Ethernet frame with an IP, UDP, and <code class="Nm">vxlan</code> header,
- the resulting frame may be larger than the MTU of the physical network. The
- <code class="Nm">vxlan</code> specification recommends the physical network
- MTU be configured to use jumbo frames to accommodate the encapsulated frame
- size.</p>
-<p class="Pp">By default, the <code class="Nm">vxlan</code> driver sets its MTU
- to usual ethernet MTU of 1500 bytes, reduced by the size of vxlan headers
- prepended to the encapsulated packets.</p>
-<p class="Pp">Alternatively, the <a class="Xr">ifconfig(8)</a>
- <code class="Cm">mtu</code> command may be used to set the fixed MTU size on
- the <code class="Nm">vxlan</code> interface to allow the encapsulated frame
- to fit in the current MTU of the physical network. If the
- <code class="Cm">mtu</code> command was used, system no longer adjust the
- <code class="Nm">vxlan</code> interface MTU on routing or address
- changes.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
-<p class="Pp">The <code class="Nm">vxlan</code> driver supports hardware
- checksum offload (receive and transmit) and TSO on the encapsulated traffic
- over physical interfaces that support these features. The
- <code class="Nm">vxlan</code> interface examines the
- <code class="Cm">vxlandev</code> interface, if one is specified, or the
- interface hosting the <code class="Cm">vxlanlocal</code> address, and
- configures its capabilities based on the hardware offload capabilities of
- that physical interface. If multiple physical interfaces will transmit or
- receive traffic for the <code class="Nm">vxlan</code> then they all must
- have the same hardware capabilities. The transmit routine of a
- <code class="Nm">vxlan</code> interface may fail with
- <code class="Er">ENXIO</code> if an outbound physical interface does not
- support an offload that the <code class="Nm">vxlan</code> interface is
- requesting. This can happen if there are multiple physical interfaces
- involved, with different hardware capabilities, or an interface capability
- was disabled after the <code class="Nm">vxlan</code> interface had already
- started.</p>
-<p class="Pp">At present, these devices are capable of generating checksums and
- performing TSO on the inner frames in hardware:
- <a class="Xr">cxgbe(4)</a>.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-<p class="Pp">Create a <code class="Nm">vxlan</code> interface in unicast mode
- with the <code class="Cm">vxlanlocal</code> tunnel address of 192.168.100.1,
- and the <code class="Cm">vxlanremote</code> tunnel address of
- 192.168.100.2.</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>ifconfig vxlan create vxlanid 108 vxlanlocal 192.168.100.1 vxlanremote 192.168.100.2</pre>
-</div>
-<p class="Pp">Create a <code class="Nm">vxlan</code> interface in multicast
- mode, with the <code class="Cm">local</code> address of 192.168.10.95, and
- the <code class="Cm">group</code> address of 224.0.2.6. The em0 interface
- will be used to transmit multicast packets.</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>ifconfig vxlan create vxlanid 42 vxlanlocal 192.168.10.95 vxlangroup 224.0.2.6 vxlandev em0</pre>
-</div>
-<p class="Pp">Once created, the <code class="Nm">vxlan</code> interface can be
- configured with <a class="Xr">ifconfig(8)</a>.</p>
-<p class="Pp">The following when placed in the file
- <span class="Pa">/etc/rc.conf</span> will cause a vxlan interface called
- &#x201C;<code class="Li">vxlan0</code>&#x201D; to be created, and will
- configure the interface in unicast mode.</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>cloned_interfaces=&quot;vxlan0&quot;
-create_args_vxlan0=&quot;vxlanid 108 vxlanlocal 192.168.100.1 vxlanremote 192.168.100.2&quot;</pre>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
- ALSO</a></h1>
-<p class="Pp"><a class="Xr">inet(4)</a>, <a class="Xr">inet6(4)</a>,
- <a class="Xr">vlan(4)</a>, <a class="Xr">rc.conf(5)</a>,
- <a class="Xr">ifconfig(8)</a>, <a class="Xr">sysctl(8)</a></p>
-<p class="Pp"><cite class="Rs"><span class="RsA">M. Mahalingam</span> and
- <span class="RsA">et al</span>, <span class="RsT">Virtual eXtensible Local
- Area Network (VXLAN): A Framework for Overlaying Virtualized Layer 2
- Networks over Layer 3 Networks</span>, <span class="RsD">August 2014</span>,
- <span class="RsO">RFC 7348</span>.</cite></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
-<p class="Pp">The <code class="Nm">vxlan</code> driver was written by
- <span class="An">Bryan Venteicher</span> &#x27E8;bryanv@freebsd.org&#x27E9;.
- Support for stateless hardware offloads was added by
- <span class="An">Navdeep Parhar</span> &#x27E8;np@freebsd.org&#x27E9; in
- <span class="Ux">FreeBSD 13.0</span>.</p>
-</section>
-</div>
-<table class="foot">
- <tr>
- <td class="foot-date">March 30, 2021</td>
- <td class="foot-os">FreeBSD 15.0</td>
- </tr>
-</table>