From 2d76f7483d2bf0857d325883fe22c924d1dfcb53 Mon Sep 17 00:00:00 2001 From: Phil Sutter Date: Mon, 7 Mar 2016 15:57:01 +0100 Subject: [PATCH] man: ip-link: document MACVLAN/MACVTAP interface types Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1013584 Upstream Status: iproute2.git commit a60223bc1c10d Conflicts: Changed context due to missing GENEVE support commit a60223bc1c10d4b172caa966acebb5a1620d0d6f Author: Phil Sutter Date: Fri Sep 25 14:09:51 2015 +0200 man: ip-link: document MACVLAN/MACVTAP interface types Signed-off-by: Phil Sutter --- man/man8/ip-link.8.in | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in index 88e014b..4614ba3 100644 --- a/man/man8/ip-link.8.in +++ b/man/man8/ip-link.8.in @@ -651,6 +651,56 @@ the following additional arguments are supported: .BI mode " MODE " - specifies the mode (datagram or connected) to use. +.TP +MACVLAN and MACVTAP Type Support +For a link of type +.I MACVLAN +or +.I MACVTAP +the following additional arguments are supported: + +.BI "ip link add link " DEVICE " name " NAME +.BR type " { " macvlan " | " macvtap " } " +.BR mode " { " private " | " vepa " | " bridge " | " passthru +.BR " [ " nopromisc " ] } " + +.in +8 +.sp +.BR type " { " macvlan " | " macvtap " } " +- specifies the link type to use. +.BR macvlan " creates just a virtual interface, while " +.BR macvtap " in addition creates a character device " +.BR /dev/tapX " to be used just like a " tuntap " device." + +.B mode private +- Do not allow communication between +.B macvlan +instances on the same physical interface, even if the external switch supports +hairpin mode. + +.B mode vepa +- Virtual Ethernet Port Aggregator mode. Data from one +.B macvlan +instance to the other on the same physical interface is transmitted over the +physical interface. Either the attached switch needs to support hairpin mode, +or there must be a TCP/IP router forwarding the packets in order to allow +communication. This is the default mode. + +.B mode bridge +- In bridge mode, all endpoints are directly connected to each other, +communication is not redirected through the physical interface's peer. + +.BR mode " " passthru " [ " nopromisc " ] " +- This mode gives more power to a single endpoint, usually in +.BR macvtap " mode. It is not allowed for more than one endpoint on the same " +physical interface. All traffic will be forwarded to this endpoint, allowing +virtio guests to change MAC address or set promiscuous mode in order to bridge +the interface or create vlan interfaces on top of it. By default, this mode +forces the underlying interface into promiscuous mode. Passing the +.BR nopromisc " flag prevents this, so the promisc flag may be controlled " +using standard tools. +.in -8 + .SS ip link delete - delete virtual link .I DEVICE specifies the virtual device to act operate on. -- 1.8.3.1