|
 |
36cfb7 |
From 266b19dec4b79c4f63118dd6151c1b0a80f521f7 Mon Sep 17 00:00:00 2001
|
|
|
36cfb7 |
From: Andrea Claudi <aclaudi@redhat.com>
|
|
|
36cfb7 |
Date: Wed, 5 Jun 2019 13:08:00 +0200
|
|
|
36cfb7 |
Subject: [PATCH] man: ip link: document GRE tunnels
|
|
|
36cfb7 |
|
|
|
36cfb7 |
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1714660
|
|
|
36cfb7 |
Upstream Status: iproute2.git commit d21c028cf7414
|
|
|
36cfb7 |
Conflicts: context change due to missing commit 1eccc5734148c
|
|
|
36cfb7 |
("ip: add vxcan/veth to ip-link man page")
|
|
|
36cfb7 |
|
|
|
36cfb7 |
commit d21c028cf74147360c530a4c53063bbe677dbe73
|
|
|
36cfb7 |
Author: Sabrina Dubroca <sd@queasysnail.net>
|
|
|
36cfb7 |
Date: Fri Apr 20 10:31:59 2018 +0200
|
|
|
36cfb7 |
|
|
|
36cfb7 |
man: ip link: document GRE tunnels
|
|
|
36cfb7 |
|
|
|
36cfb7 |
GRE tunnels are currently only documented together with IPIP and SIT
|
|
|
36cfb7 |
tunnels, but they actually have very different configuration
|
|
|
36cfb7 |
options. Let's separate them.
|
|
|
36cfb7 |
|
|
|
36cfb7 |
Signed-off-by: Sabrina Dubroca <sd@queasysnail.net>
|
|
|
36cfb7 |
Signed-off-by: David Ahern <dsahern@gmail.com>
|
|
|
36cfb7 |
---
|
|
|
36cfb7 |
man/man8/ip-link.8.in | 152 ++++++++++++++++++++++++++++++++++++++++--
|
|
|
36cfb7 |
1 file changed, 148 insertions(+), 4 deletions(-)
|
|
|
36cfb7 |
|
|
|
36cfb7 |
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
|
|
|
36cfb7 |
index 48417dbce80aa..cfea1bdfdc030 100644
|
|
|
36cfb7 |
--- a/man/man8/ip-link.8.in
|
|
|
36cfb7 |
+++ b/man/man8/ip-link.8.in
|
|
|
36cfb7 |
@@ -643,15 +643,88 @@ keyword.
|
|
|
36cfb7 |
.in -8
|
|
|
36cfb7 |
|
|
|
36cfb7 |
.TP
|
|
|
36cfb7 |
-GRE, IPIP, SIT Type Support
|
|
|
36cfb7 |
-For a link of types
|
|
|
36cfb7 |
-.I GRE/IPIP/SIT
|
|
|
36cfb7 |
+IPIP, SIT Type Support
|
|
|
36cfb7 |
+For a link of type
|
|
|
36cfb7 |
+.IR IPIP or SIT
|
|
|
36cfb7 |
+the following additional arguments are supported:
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.BI "ip link add " DEVICE
|
|
|
36cfb7 |
+.BR type " { " ipip " | " sit " }"
|
|
|
36cfb7 |
+.BI " remote " ADDR " local " ADDR
|
|
|
36cfb7 |
+[
|
|
|
36cfb7 |
+.BR encap " { " fou " | " gue " | " none " }"
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BR encap-sport " { " \fIPORT " | " auto " }"
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BI "encap-dport " PORT
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ no ] encap-csum
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ no ] encap-remcsum
|
|
|
36cfb7 |
+]
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.in +8
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BI remote " ADDR "
|
|
|
36cfb7 |
+- specifies the remote address of the tunnel.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BI local " ADDR "
|
|
|
36cfb7 |
+- specifies the fixed local address for tunneled packets.
|
|
|
36cfb7 |
+It must be an address on another interface on this host.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BR encap " { " fou " | " gue " | " none " }"
|
|
|
36cfb7 |
+- specifies type of secondary UDP encapsulation. "fou" indicates
|
|
|
36cfb7 |
+Foo-Over-UDP, "gue" indicates Generic UDP Encapsulation.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BR encap-sport " { " \fIPORT " | " auto " }"
|
|
|
36cfb7 |
+- specifies the source port in UDP encapsulation.
|
|
|
36cfb7 |
+.IR PORT
|
|
|
36cfb7 |
+indicates the port by number, "auto"
|
|
|
36cfb7 |
+indicates that the port number should be chosen automatically
|
|
|
36cfb7 |
+(the kernel picks a flow based on the flow hash of the
|
|
|
36cfb7 |
+encapsulated packet).
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ no ] encap-csum
|
|
|
36cfb7 |
+- specifies if UDP checksums are enabled in the secondary
|
|
|
36cfb7 |
+encapsulation.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ no ] encap-remcsum
|
|
|
36cfb7 |
+- specifies if Remote Checksum Offload is enabled. This is only
|
|
|
36cfb7 |
+applicable for Generic UDP Encapsulation.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.in -8
|
|
|
36cfb7 |
+.TP
|
|
|
36cfb7 |
+GRE Type Support
|
|
|
36cfb7 |
+For a link of type
|
|
|
36cfb7 |
+.IR GRE " or " GRETAP
|
|
|
36cfb7 |
the following additional arguments are supported:
|
|
|
36cfb7 |
|
|
|
36cfb7 |
.BI "ip link add " DEVICE
|
|
|
36cfb7 |
-.BR type " { " gre " | " ipip " | " sit " }"
|
|
|
36cfb7 |
+.BR type " { " gre " | " gretap " }"
|
|
|
36cfb7 |
.BI " remote " ADDR " local " ADDR
|
|
|
36cfb7 |
[
|
|
|
36cfb7 |
+.RB [ i | o ] seq
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ i | o ] key
|
|
|
36cfb7 |
+.I KEY
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ i | o ] csum
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BI ttl " TTL "
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BI tos " TOS "
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ no ] pmtudisc
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.RB [ no ] ignore-df
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BI dev " PHYS_DEV "
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
.BR encap " { " fou " | " gue " | " none " }"
|
|
|
36cfb7 |
] [
|
|
|
36cfb7 |
.BR encap-sport " { " \fIPORT " | " auto " }"
|
|
|
36cfb7 |
@@ -661,6 +734,8 @@ the following additional arguments are supported:
|
|
|
36cfb7 |
.RB [ no ] encap-csum
|
|
|
36cfb7 |
] [
|
|
|
36cfb7 |
.RB [ no ] encap-remcsum
|
|
|
36cfb7 |
+] [
|
|
|
36cfb7 |
+.BR external
|
|
|
36cfb7 |
]
|
|
|
36cfb7 |
|
|
|
36cfb7 |
.in +8
|
|
|
36cfb7 |
@@ -673,6 +748,70 @@ the following additional arguments are supported:
|
|
|
36cfb7 |
- specifies the fixed local address for tunneled packets.
|
|
|
36cfb7 |
It must be an address on another interface on this host.
|
|
|
36cfb7 |
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ i | o ] seq
|
|
|
36cfb7 |
+- serialize packets.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.B oseq
|
|
|
36cfb7 |
+flag enables sequencing of outgoing packets.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.B iseq
|
|
|
36cfb7 |
+flag requires that all input packets are serialized.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ i | o ] key
|
|
|
36cfb7 |
+.I KEY
|
|
|
36cfb7 |
+- use keyed GRE with key
|
|
|
36cfb7 |
+.IR KEY ". "KEY
|
|
|
36cfb7 |
+is either a number or an IPv4 address-like dotted quad.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.B key
|
|
|
36cfb7 |
+parameter specifies the same key to use in both directions.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.BR ikey " and " okey
|
|
|
36cfb7 |
+parameters specify different keys for input and output.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ i | o ] csum
|
|
|
36cfb7 |
+- generate/require checksums for tunneled packets.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.B ocsum
|
|
|
36cfb7 |
+flag calculates checksums for outgoing packets.
|
|
|
36cfb7 |
+The
|
|
|
36cfb7 |
+.B icsum
|
|
|
36cfb7 |
+flag requires that all input packets have the correct
|
|
|
36cfb7 |
+checksum. The
|
|
|
36cfb7 |
+.B csum
|
|
|
36cfb7 |
+flag is equivalent to the combination
|
|
|
36cfb7 |
+.B "icsum ocsum" .
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BI ttl " TTL"
|
|
|
36cfb7 |
+- specifies the TTL value to use in outgoing packets.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BI tos " TOS"
|
|
|
36cfb7 |
+- specifies the TOS value to use in outgoing packets.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ no ] pmtudisc
|
|
|
36cfb7 |
+- enables/disables Path MTU Discovery on this tunnel.
|
|
|
36cfb7 |
+It is enabled by default. Note that a fixed ttl is incompatible
|
|
|
36cfb7 |
+with this option: tunneling with a fixed ttl always makes pmtu
|
|
|
36cfb7 |
+discovery.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.RB [ no ] ignore-df
|
|
|
36cfb7 |
+- enables/disables IPv4 DF suppression on this tunnel.
|
|
|
36cfb7 |
+Normally datagrams that exceed the MTU will be fragmented; the presence
|
|
|
36cfb7 |
+of the DF flag inhibits this, resulting instead in an ICMP Unreachable
|
|
|
36cfb7 |
+(Fragmentation Required) message. Enabling this attribute casues the
|
|
|
36cfb7 |
+DF flag to be ignored.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BI dev " PHYS_DEV"
|
|
|
36cfb7 |
+- specifies the physical device to use for tunnel endpoint communication.
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
.sp
|
|
|
36cfb7 |
.BR encap " { " fou " | " gue " | " none " }"
|
|
|
36cfb7 |
- specifies type of secondary UDP encapsulation. "fou" indicates
|
|
|
36cfb7 |
@@ -697,6 +836,11 @@ encapsulation.
|
|
|
36cfb7 |
- specifies if Remote Checksum Offload is enabled. This is only
|
|
|
36cfb7 |
applicable for Generic UDP Encapsulation.
|
|
|
36cfb7 |
|
|
|
36cfb7 |
+.sp
|
|
|
36cfb7 |
+.BR external
|
|
|
36cfb7 |
+- make this tunnel externally controlled
|
|
|
36cfb7 |
+.RB "(e.g. " "ip route encap" ).
|
|
|
36cfb7 |
+
|
|
|
36cfb7 |
.in -8
|
|
|
36cfb7 |
|
|
|
36cfb7 |
.TP
|
|
|
36cfb7 |
--
|
|
|
e138d9 |
2.21.0
|
|
|
36cfb7 |
|