1 .TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux"
3 ip-tunnel - tunnel configuration
14 .BR "tunnel" " { " add " | " change " | " del " | " show " | " prl " | " 6rd " }"
24 .RB "[ [" i "|" o "]" seq " ] [ [" i "|" o "]" key
26 .RB "[" i "|" o "]" csum " ] ]"
30 .RB "[ " ttl "|" hoplimit
51 .RB "[ [" no "]" pmtudisc " ]"
52 .RB "[ [" no "]" ignore-df " ]"
53 .RB "[ [" no "]" allow-localremote " ]"
60 .RB " { " ipip " | " gre " | " sit " | " isatap " | " vti " | " ip6ip6 " | " ipip6 " | " ip6gre " | " vti6 " | " any " }"
63 .IR ADDR " := { " IP_ADDRESS " |"
67 .IR TOS " := { " STRING " | " 00 ".." ff " |"
71 .BI "inherit/" 00 ".." ff
81 .IR TTL " := { " 1 ".." 255 " | "
85 .IR KEY " := { " DOTTED_QUAD " | " NUMBER " }"
89 objects are tunnels, encapsulating packets in IP packets and then
90 sending them over the IP infrastructure.
91 The encapsulating (or outer) address family is specified by the
93 option. The default is IPv4.
100 change an existing tunnel
106 .BI name " NAME " (default)
107 select the tunnel device name.
111 set the tunnel mode. Available modes depend on the encapsulating address family.
113 Modes for IPv4 encapsulation available:
114 .BR ipip ", " sit ", " isatap ", " vti ", and " gre "."
116 Modes for IPv6 encapsulation available:
117 .BR ip6ip6 ", " ipip6 ", " ip6gre ", " vti6 ", and " any "."
120 .BI remote " ADDRESS"
121 set the remote endpoint of the tunnel.
125 set the fixed local address for tunneled packets.
126 It must be an address on another interface of this host.
132 set a fixed TTL (IPv4) or hoplimit (IPv6)
136 is a number in the range 1--255. 0 is a special value
137 meaning that packets inherit the TTL value.
138 The default value for IPv4 tunnels is:
140 The default value for IPv6 tunnels is:
150 set the type of service (IPv4) or traffic class (IPv6) field on
151 tunneled packets, which can be specified as either a two-digit
152 hex value (e.g. c0) or a predefined string (e.g. internet).
155 causes the field to be copied from the original IP header. The
157 .BI "inherit/" STRING
159 .BI "inherit/" 00 ".." ff
160 will set the field to
164 when tunneling non-IP packets. The default value is 00.
168 bind the tunnel to the device
170 so that tunneled packets will only be routed via this device and will
171 not be able to escape to another device when the route to endpoint
176 disable Path MTU Discovery on this tunnel.
177 It is enabled by default. Note that a fixed ttl is incompatible
178 with this option: tunneling with a fixed ttl always makes pmtu
183 enable IPv4 DF suppression on this tunnel.
184 Normally datagrams that exceed the MTU will be fragmented; the presence
185 of the DF flag inhibits this, resulting instead in an ICMP Unreachable
186 (Fragmentation Required) message. Enabling this attribute casues the
187 DF flag to be ignored.
195 .RB ( " only GRE tunnels " )
196 use keyed GRE with key
198 is either a number or an IP address-like dotted quad.
201 parameter sets the key to use in both directions.
203 .BR ikey " and " okey
204 parameters set different keys for input and output.
207 .BR csum ", " icsum ", " ocsum
208 .RB ( " only GRE tunnels " )
209 generate/require checksums for tunneled packets.
212 flag calculates checksums for outgoing packets.
215 flag requires that all input packets have the correct
218 flag is equivalent to the combination
222 .BR seq ", " iseq ", " oseq
223 .RB ( " only GRE tunnels " )
227 flag enables sequencing of outgoing packets.
230 flag requires that all input packets are serialized.
233 flag is equivalent to the combination
235 .B It doesn't work. Don't use it.
239 .RB ( " only IPv6 tunnels " )
240 set a fixed encapsulation limit. Default is 4.
243 .BI flowlabel " FLOWLABEL"
244 .RB ( " only IPv6 tunnels " )
245 set a fixed flowlabel.
248 .BI allow-localremote
249 .RB ( " only IPv6 tunnels " )
250 allow remote endpoint on the local host.
255 potential router list (ISATAP only)
259 mandatory device name.
262 .BI prl-default " ADDR"
264 .BI prl-nodefault " ADDR"
266 .BI prl-delete " ADDR"
267 .RB "Add or delete " ADDR
268 as a potential router or default router.
274 This command has no arguments.
281 Original Manpage by Michail Litvak <mci@owl.openwall.com>