|
 |
a4b897 |
From 8951dc99dc6a881e95420d0591bcb374f0c373d7 Mon Sep 17 00:00:00 2001
|
|
|
a4b897 |
From: =?UTF-8?q?Pavel=20=C5=A0imerda?= <psimerda@redhat.com>
|
|
|
a4b897 |
Date: Wed, 12 Aug 2015 22:04:07 +0200
|
|
|
a4b897 |
Subject: [PATCH] ip-link: fix and extend documentation
|
|
|
5ebd6f |
|
|
|
a4b897 |
* Add `can` to list of supported link types
|
|
|
a4b897 |
* Document `addrgenmode`
|
|
|
a4b897 |
* Document `link-netnsid`
|
|
|
a4b897 |
* Document VLAN link type
|
|
|
a4b897 |
* Improve VXLAN link type documentation
|
|
|
a4b897 |
- Fix VXLAN srcport/dstport docs
|
|
|
a4b897 |
- Document `udpcsum`, `udp6zerocsumtx` and `udp6zerocsumrx`
|
|
|
5ebd6f |
---
|
|
|
a4b897 |
man/man8/ip-link.8.in | 96 +++++++++++++++++++++++++++++++++++++++++++++++++--
|
|
|
a4b897 |
1 file changed, 93 insertions(+), 3 deletions(-)
|
|
|
5ebd6f |
|
|
|
5ebd6f |
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
|
|
|
a4b897 |
index 844127d..a45bc05 100644
|
|
|
5ebd6f |
--- a/man/man8/ip-link.8.in
|
|
|
5ebd6f |
+++ b/man/man8/ip-link.8.in
|
|
|
a4b897 |
@@ -126,6 +126,8 @@ ip-link \- network device configuration
|
|
|
a4b897 |
.B nomaster " |"
|
|
|
a4b897 |
.br
|
|
|
a4b897 |
.B addrgenmode { eui64 | none }
|
|
|
a4b897 |
+.br
|
|
|
a4b897 |
+.B link-netnsid ID
|
|
|
a4b897 |
.BR " }"
|
|
|
a4b897 |
|
|
|
a4b897 |
|
|
|
a4b897 |
@@ -259,6 +261,66 @@ the following additional arguments are supported:
|
|
|
a4b897 |
.in -8
|
|
|
5ebd6f |
|
|
|
5ebd6f |
.TP
|
|
|
5ebd6f |
+VLAN Type Support
|
|
|
5ebd6f |
+For a link of type
|
|
|
5ebd6f |
+.I VLAN
|
|
|
5ebd6f |
+the following additional arguments are supported:
|
|
|
5ebd6f |
+
|
|
|
a4b897 |
+.BI "ip link add
|
|
|
a4b897 |
+.BI link " DEVICE "
|
|
|
5ebd6f |
+.BI name " NAME "
|
|
|
5ebd6f |
+.BI type " vlan "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BI protocol " VLAN_PROTO "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.BI id " VLANID "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BR reorder_hdr " { " on " | " off " } "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BR gvrp " { " on " | " off " } "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BR mvrp " { " on " | " off " } "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BR loose_binding " { " on " | " off " } "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BI ingress-qos-map " QOS-MAP "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+.R " [ "
|
|
|
5ebd6f |
+.BI egress-qos-map " QOS-MAP "
|
|
|
5ebd6f |
+.R " ] "
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.in +8
|
|
|
5ebd6f |
+.sp
|
|
|
5ebd6f |
+.BI protocol " VLAN_PROTO "
|
|
|
5ebd6f |
+- either 802.1Q or 802.1ad.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BI id " VLANID "
|
|
|
a4b897 |
+- specifies the VLAN Identifer to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadeimal, respectively.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BR reorder_hdr " { " on " | " off " } "
|
|
|
5ebd6f |
+- specifies whether ethernet headers are reordered or not.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BR gvrp " { " on " | " off " } "
|
|
|
5ebd6f |
+- specifies whether this VLAN should be registered using GARP VLAN Registration Protocol.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BR mvrp " { " on " | " off " } "
|
|
|
5ebd6f |
+- specifies whether this VLAN should be registered using Multiple VLAN Registration Protocol.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BR loose_binding " { " on " | " off " } "
|
|
|
5ebd6f |
+- specifies whether the VLAN device state is bound to the physical device state.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BI ingress-qos-map " QOS-MAP "
|
|
|
5ebd6f |
+- defines a mapping between priority code points on incoming frames. The format is FROM:TO with multiple mappings separated by spaces.
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.BI egress-qos-map " QOS-MAP "
|
|
|
5ebd6f |
+- the same as ingress-qos-map but for outgoing frames.
|
|
|
5ebd6f |
+.in -8
|
|
|
5ebd6f |
+
|
|
|
5ebd6f |
+.TP
|
|
|
5ebd6f |
VXLAN Type Support
|
|
|
5ebd6f |
For a link of type
|
|
|
5ebd6f |
.I VXLAN
|
|
|
a4b897 |
@@ -277,7 +339,9 @@ the following additional arguments are supported:
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
.BI tos " TOS "
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
-.BI port " MIN MAX "
|
|
|
a4b897 |
+.BI dstport " PORT "
|
|
|
a4b897 |
+.R " ] [ "
|
|
|
a4b897 |
+.BI srcport " MIN MAX "
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
.I "[no]learning "
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
@@ -289,6 +353,12 @@ the following additional arguments are supported:
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
.I "[no]l3miss "
|
|
|
a4b897 |
.R " ] [ "
|
|
|
a4b897 |
+.I "[no]udpcsum "
|
|
|
a4b897 |
+.R " ] [ "
|
|
|
a4b897 |
+.I "[no]udp6zerocsumtx "
|
|
|
a4b897 |
+.R " ] [ "
|
|
|
a4b897 |
+.I "[no]udp6zerocsumrx "
|
|
|
a4b897 |
+.R " ] [ "
|
|
|
a4b897 |
.B gbp
|
|
|
a4b897 |
.R " ]"
|
|
|
a4b897 |
|
|
|
a4b897 |
@@ -329,7 +399,11 @@ parameter.
|
|
|
a4b897 |
- specifies the TOS value to use in outgoing packets.
|
|
|
a4b897 |
|
|
|
a4b897 |
.sp
|
|
|
a4b897 |
-.BI port " MIN MAX"
|
|
|
a4b897 |
+.BI dstport " PORT"
|
|
|
a4b897 |
+- specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
|
|
|
a4b897 |
+
|
|
|
a4b897 |
+.sp
|
|
|
a4b897 |
+.BI srcport " MIN MAX"
|
|
|
a4b897 |
- specifies the range of port numbers to use as UDP
|
|
|
a4b897 |
source ports to communicate to the remote VXLAN tunnel endpoint.
|
|
|
a4b897 |
|
|
|
a4b897 |
@@ -355,6 +429,18 @@ are entered into the VXLAN device forwarding database.
|
|
|
a4b897 |
- specifies if netlink IP ADDR miss notifications are generated.
|
|
|
a4b897 |
|
|
|
a4b897 |
.sp
|
|
|
a4b897 |
+.I [no]udpcsum
|
|
|
a4b897 |
+- specifies if UDP checksum is filled in
|
|
|
a4b897 |
+
|
|
|
a4b897 |
+.sp
|
|
|
a4b897 |
+.I [no]udp6zerocsumtx
|
|
|
a4b897 |
+- specifies if UDP checksum is filled in
|
|
|
a4b897 |
+
|
|
|
a4b897 |
+.sp
|
|
|
a4b897 |
+.I [no]udp6zerocsumrx
|
|
|
a4b897 |
+- specifies if UDP checksum is received
|
|
|
a4b897 |
+
|
|
|
a4b897 |
+.sp
|
|
|
a4b897 |
.B gbp
|
|
|
a4b897 |
- enables the Group Policy extension (VXLAN-GBP).
|
|
|
a4b897 |
|
|
|
a4b897 |
@@ -577,7 +663,11 @@ unset master device of the device (release device).
|
|
|
a4b897 |
|
|
|
a4b897 |
.TP
|
|
|
a4b897 |
.BR "addrgenmode eui64 " or " addrgenmode none"
|
|
|
a4b897 |
-allow to ipv6 set address generation mode
|
|
|
a4b897 |
+set IPv6 address generation mode
|
|
|
a4b897 |
+
|
|
|
a4b897 |
+.TP
|
|
|
a4b897 |
+.BR "link-netnsid "
|
|
|
a4b897 |
+set peer netnsid for a cross-netns interface
|
|
|
a4b897 |
|
|
|
a4b897 |
.PP
|
|
|
a4b897 |
.B Warning:
|
|
|
5ebd6f |
--
|
|
|
5ebd6f |
1.8.3.1
|
|
|
5ebd6f |
|