Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/vxlan.4
Show All 18 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd September 17, 2020 | .Dd March 30, 2021 | ||||
.Dt VXLAN 4 | .Dt VXLAN 4 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm vxlan | .Nm vxlan | ||||
.Nd "Virtual eXtensible LAN interface" | .Nd "Virtual eXtensible LAN interface" | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
To compile this driver into the kernel, | To compile this driver into the kernel, | ||||
place the following line in your | place the following line in your | ||||
▲ Show 20 Lines • Show All 134 Lines • ▼ Show 20 Lines | |||||
interface encapsulates the Ethernet frame with an IP, UDP, and | interface encapsulates the Ethernet frame with an IP, UDP, and | ||||
.Nm | .Nm | ||||
header, the resulting frame may be larger than the MTU of the | header, the resulting frame may be larger than the MTU of the | ||||
physical network. | physical network. | ||||
The | The | ||||
.Nm | .Nm | ||||
specification recommends the physical network MTU be configured | specification recommends the physical network MTU be configured | ||||
to use jumbo frames to accommodate the encapsulated frame size. | to use jumbo frames to accommodate the encapsulated frame size. | ||||
.Pp | |||||
By default, the | |||||
.Nm | |||||
driver sets it MTU to usual ethernet MTU of 1500 bytes, reduced by | |||||
np: Minor nit: "sets its MTU" instead of "sets it MTU" | |||||
the size of vxlan headers prepended to the encapsulated packets. | |||||
.Pp | |||||
Alternatively, the | Alternatively, the | ||||
.Xr ifconfig 8 | .Xr ifconfig 8 | ||||
.Cm mtu | .Cm mtu | ||||
command may be used to reduce the MTU size on the | command may be used to fixate the MTU size on the | ||||
npUnsubmitted Not Done Inline ActionsMaybe use "set" instead of "fixate"? np: Maybe use "set" instead of "fixate"? | |||||
kibAuthorUnsubmitted Done Inline ActionsI wrote it as used to set the fixed MTU, I want to highlight that it is non-adjustable there, in addition to the sentence after. kib: I wrote it as `used to set the fixed MTU`, I want to highlight that it is non-adjustable there… | |||||
.Nm | .Nm | ||||
interface to allow the encapsulated frame to fit in the | interface to allow the encapsulated frame to fit in the | ||||
current MTU of the physical network. | current MTU of the physical network. | ||||
If the | |||||
.Cm mtu | |||||
command was used, system no longer adjust the | |||||
.Nm | |||||
interface MTU on routing or address changes. | |||||
.Sh HARDWARE | .Sh HARDWARE | ||||
The | The | ||||
.Nm | .Nm | ||||
driver supports hardware checksum offload (receive and transmit) and TSO on the | driver supports hardware checksum offload (receive and transmit) and TSO on the | ||||
encapsulated traffic over physical interfaces that support these features. | encapsulated traffic over physical interfaces that support these features. | ||||
The | The | ||||
.Nm | .Nm | ||||
interface examines the | interface examines the | ||||
▲ Show 20 Lines • Show All 91 Lines • Show Last 20 Lines |
Minor nit: "sets its MTU" instead of "sets it MTU"