1
.TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux"
3
ip-tunnel - tunnel configuration
12
.RI " { " COMMAND " | "
16
.BR "ip tunnel" " { " add " | " change " | " del " | " show " | " prl " }"
26
.RB "[ [" i "|" o "]" seq " ] [ [" i "|" o "]" key
28
.RB "[" i "|" o "]" csum " ] ]"
47
.RB "[ [" no "]" pmtudisc " ]"
50
.RB "[ " "dscp inherit" " ]"
54
.RB " { " ipip " | " gre " | " sit " | " isatap " | " ip6ip6 " | " ipip6 " | " any " }"
57
.IR ADDR " := { " IP_ADDRESS " |"
61
.IR TOS " := { " NUMBER " |"
71
.IR TTL " := { " 1 ".." 255 " | "
75
.IR KEY " := { " DOTTED_QUAD " | " NUMBER " }"
78
.IR TIME " := " NUMBER "[s|ms]"
82
objects are tunnels, encapsulating packets in IP packets and then
83
sending them over the IP infrastructure.
84
The encapulating (or outer) address family is specified by the
86
option. The default is IPv4.
88
.SS ip tunnel add - add a new tunnel
89
.SS ip tunnel change - change an existing tunnel
90
.SS ip tunnel delete - destroy a tunnel
93
.BI name " NAME " (default)
94
select the tunnel device name.
98
set the tunnel mode. Available modes depend on the encapsulating address family.
100
Modes for IPv4 encapsulation available:
101
.BR ipip ", " sit ", " isatap " and " gre "."
103
Modes for IPv6 encapsulation available:
104
.BR ip6ip6 ", " ipip6 " and " any "."
107
.BI remote " ADDRESS"
108
set the remote endpoint of the tunnel.
112
set the fixed local address for tunneled packets.
113
It must be an address on another interface of this host.
121
is a number in the range 1--255. 0 is a special value
122
meaning that packets inherit the TTL value.
123
The default value for IPv4 tunnels is:
125
The default value for IPv6 tunnels is:
135
set a fixed TOS (or traffic class in IPv6)
138
The default value is:
143
bind the tunnel to the device
145
so that tunneled packets will only be routed via this device and will
146
not be able to escape to another device when the route to endpoint
151
disable Path MTU Discovery on this tunnel.
152
It is enabled by default. Note that a fixed ttl is incompatible
153
with this option: tunnelling with a fixed ttl always makes pmtu
162
.RB ( " only GRE tunnels " )
163
use keyed GRE with key
165
is either a number or an IP address-like dotted quad.
168
parameter sets the key to use in both directions.
170
.BR ikey " and " okey
171
parameters set different keys for input and output.
174
.BR csum ", " icsum ", " ocsum
175
.RB ( " only GRE tunnels " )
176
generate/require checksums for tunneled packets.
179
flag calculates checksums for outgoing packets.
182
flag requires that all input packets have the correct
185
flag is equivalent to the combination
189
.BR seq ", " iseq ", " oseq
190
.RB ( " only GRE tunnels " )
194
flag enables sequencing of outgoing packets.
197
flag requires that all input packets are serialized.
200
flag is equivalent to the combination
202
.B It isn't work. Don't use it.
206
.RB ( " only IPv6 tunnels " )
207
Inherit DS field between inner and outer header.
211
.RB ( " only IPv6 tunnels " )
212
set a fixed encapsulation limit. Default is 4.
215
.BI flowlabel " FLOWLABEL"
216
.RB ( " only IPv6 tunnels " )
217
set a fixed flowlabel.
219
.SS ip tunnel prl - potential router list (ISATAP only)
223
mandatory device name.
226
.BI prl-default " ADDR"
228
.BI prl-nodefault " ADDR"
230
.BI prl-delete " ADDR"
231
.RB "Add or delete " ADDR
232
as a potential router or default router.
234
.SS ip tunnel show - list tunnels
235
This command has no arguments.
242
Original Manpage by Michail Litvak <mci@owl.openwall.com>