| vxlan.4 (273331) | vxlan.4 (275851) |
|---|---|
| 1.\" Copyright (c) 2014 Bryan Venteicher 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" | 1.\" Copyright (c) 2014 Bryan Venteicher 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" |
| 25.\" $FreeBSD: head/share/man/man4/vxlan.4 273331 2014-10-20 14:42:42Z bryanv $ | 25.\" $FreeBSD: head/share/man/man4/vxlan.4 275851 2014-12-17 05:36:34Z bryanv $ |
| 26.\" | 26.\" |
| 27.Dd October 20, 2014 | 27.Dd December 16, 2014 |
| 28.Dt VXLAN 4 29.Os 30.Sh NAME 31.Nm vxlan 32.Nd "Virtual eXtensible LAN interface" 33.Sh SYNOPSIS 34To compile this driver into the kernel, 35place the following line in your --- 99 unchanged lines hidden (view full) --- 135segment is identified by a 24-bit value in the 136.Nm 137header called the 138.Dq VXLAN Network Identifier , 139or VNI. 140.Pp 141When configured with the 142.Xr ifconfig 8 | 28.Dt VXLAN 4 29.Os 30.Sh NAME 31.Nm vxlan 32.Nd "Virtual eXtensible LAN interface" 33.Sh SYNOPSIS 34To compile this driver into the kernel, 35place the following line in your --- 99 unchanged lines hidden (view full) --- 135segment is identified by a 24-bit value in the 136.Nm 137header called the 138.Dq VXLAN Network Identifier , 139or VNI. 140.Pp 141When configured with the 142.Xr ifconfig 8 |
| 143.Cm learn | 143.Cm vxlanlearn |
| 144parameter, the interface dynamically creates forwarding table entries 145from received packets. 146An entry in the forwarding table maps the inner source MAC address 147to the outer remote IP address. 148During transmit, the interface attempts to lookup an entry for 149the encapsulated destination MAC address. 150If an entry is found, the IP address in the entry is used to directly 151transmit the encapsulated frame to the destination. 152Otherwise, when configured in multicast mode, 153the interface must flood the frame to all hosts in the group. 154The maximum number of entries in the table is configurable with the 155.Xr ifconfig 8 | 144parameter, the interface dynamically creates forwarding table entries 145from received packets. 146An entry in the forwarding table maps the inner source MAC address 147to the outer remote IP address. 148During transmit, the interface attempts to lookup an entry for 149the encapsulated destination MAC address. 150If an entry is found, the IP address in the entry is used to directly 151transmit the encapsulated frame to the destination. 152Otherwise, when configured in multicast mode, 153the interface must flood the frame to all hosts in the group. 154The maximum number of entries in the table is configurable with the 155.Xr ifconfig 8 |
| 156.Cm maxaddr | 156.Cm vxlanmaxaddr |
| 157command. 158Stale entries in the table periodically pruned. 159The timeout is configurable with the 160.Xr ifconfig 8 | 157command. 158Stale entries in the table periodically pruned. 159The timeout is configurable with the 160.Xr ifconfig 8 |
| 161.Cm timeout | 161.Cm vxlantimeout |
| 162command. 163The table may be viewed with the 164.Xr sysctl 8 | 162command. 163The table may be viewed with the 164.Xr sysctl 8 |
| 165.Cm net.link.vlxan.N.ftable.dump | 165.Cm net.link.vxlan.N.ftable.dump |
| 166command. 167.Sh MTU 168Since the 169.Nm 170interface encapsulates the Ethernet frame with an IP, UDP, and 171.Nm 172header, the resulting frame may be larger than the MTU of the 173physical network. --- 8 unchanged lines hidden (view full) --- 182.Nm 183interface to allow the encapsulated frame to fit in the 184current MTU of the physical network. 185.Sh EXAMPLES 186Create a 187.Nm 188interface in unicast mode 189with the | 166command. 167.Sh MTU 168Since the 169.Nm 170interface encapsulates the Ethernet frame with an IP, UDP, and 171.Nm 172header, the resulting frame may be larger than the MTU of the 173physical network. --- 8 unchanged lines hidden (view full) --- 182.Nm 183interface to allow the encapsulated frame to fit in the 184current MTU of the physical network. 185.Sh EXAMPLES 186Create a 187.Nm 188interface in unicast mode 189with the |
| 190.Cm local | 190.Cm vxlanlocal |
| 191tunnel address of 192.168.100.1, 192and the | 191tunnel address of 192.168.100.1, 192and the |
| 193.Cm remote | 193.Cm vxlanremote |
| 194tunnel address of 192.168.100.2. 195.Bd -literal -offset indent | 194tunnel address of 192.168.100.2. 195.Bd -literal -offset indent |
| 196ifconfig vxlan create vni 108 local 192.168.100.1 remote 192.168.100.2 | 196ifconfig vxlan create vxlanid 108 vxlanlocal 192.168.100.1 vxlanremote 192.168.100.2 |
| 197.Ed 198.Pp 199Create a 200.Nm 201interface in multicast mode, 202with the 203.Cm local 204address of 192.168.10.95, 205and the 206.Cm group 207address of 224.0.2.6. 208The em0 interface will be used to transmit multicast packets. 209.Bd -literal -offset indent | 197.Ed 198.Pp 199Create a 200.Nm 201interface in multicast mode, 202with the 203.Cm local 204address of 192.168.10.95, 205and the 206.Cm group 207address of 224.0.2.6. 208The em0 interface will be used to transmit multicast packets. 209.Bd -literal -offset indent |
| 210ifconfig vxlan create vni 42 local 192.168.10.95 group 224.0.2.6 vxlandev em0 | 210ifconfig vxlan create vxlanid 42 vxlanlocal 192.168.10.95 vxlangroup 224.0.2.6 vxlandev em0 |
| 211.Ed 212.Pp 213Once created, the 214.Nm 215interface can be configured with 216.Xr ifconfig 8 . 217.Sh SEE ALSO 218.Xr ifconfig 8 , --- 17 unchanged lines hidden --- | 211.Ed 212.Pp 213Once created, the 214.Nm 215interface can be configured with 216.Xr ifconfig 8 . 217.Sh SEE ALSO 218.Xr ifconfig 8 , --- 17 unchanged lines hidden --- |