]>
Commit | Line | Data |
---|---|---|
2a9721f1 SH |
1 | .TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux" |
2 | .SH "NAME" | |
aab2702d | 3 | ip-tunnel - tunnel configuration |
2a9721f1 SH |
4 | .SH "SYNOPSIS" |
5 | .sp | |
6 | .ad l | |
7 | .in +8 | |
8 | .ti -8 | |
9 | .B ip | |
10 | .RI "[ " OPTIONS " ]" | |
11 | .B tunnel | |
12 | .RI " { " COMMAND " | " | |
13 | .BR help " }" | |
14 | .sp | |
15 | .ti -8 | |
16 | .BR "ip tunnel" " { " add " | " change " | " del " | " show " | " prl " }" | |
17 | .RI "[ " NAME " ]" | |
18 | .br | |
19 | .RB "[ " mode | |
20 | .IR MODE " ] [ " | |
21 | .B remote | |
22 | .IR ADDR " ] [ " | |
23 | .B local | |
24 | .IR ADDR " ]" | |
25 | .br | |
26 | .RB "[ [" i "|" o "]" seq " ] [ [" i "|" o "]" key | |
27 | .IR KEY " ] [ " | |
28 | .RB "[" i "|" o "]" csum " ] ]" | |
29 | .br | |
30 | .RB "[ " encaplimit | |
31 | .IR ELIM " ]" | |
32 | .RB "[ " ttl | |
33 | .IR TTL " ]" | |
34 | .br | |
35 | .RB "[ " tos | |
36 | .IR TOS " ] [ " | |
37 | .B flowlabel | |
38 | .IR FLOWLABEL " ]" | |
39 | .br | |
40 | .RB "[ " prl-default | |
41 | .IR ADDR " ] [ " | |
42 | .B prl-nodefault | |
43 | .IR ADDR " ] [ " | |
44 | .B prl-delete | |
45 | .IR ADDR " ]" | |
46 | .br | |
47 | .RB "[ [" no "]" pmtudisc " ]" | |
48 | .RB "[ " dev | |
49 | .IR PHYS_DEV " ]" | |
2a9721f1 SH |
50 | |
51 | .ti -8 | |
52 | .IR MODE " := " | |
9abde37c | 53 | .RB " { " ipip " | " gre " | " sit " | " isatap " | " ip6ip6 " | " ipip6 " | " ip6gre " | " any " }" |
2a9721f1 SH |
54 | |
55 | .ti -8 | |
56 | .IR ADDR " := { " IP_ADDRESS " |" | |
57 | .BR any " }" | |
58 | ||
59 | .ti -8 | |
e59fd3db DW |
60 | .IR TOS " := { " STRING " | " 00 ".." ff " |" |
61 | .BR inherit " |" | |
62 | .BI "inherit/" STRING | |
daa45cad | 63 | .RB "|" |
e59fd3db | 64 | .BI "inherit/" 00 ".." ff |
daa45cad | 65 | .RB "}" |
2a9721f1 SH |
66 | |
67 | .ti -8 | |
68 | .IR ELIM " := {" | |
69 | .BR none " | " | |
70 | .IR 0 ".." 255 " }" | |
71 | ||
72 | .ti -8 | |
73 | .ti -8 | |
74 | .IR TTL " := { " 1 ".." 255 " | " | |
75 | .BR inherit " }" | |
76 | ||
77 | .ti -8 | |
78 | .IR KEY " := { " DOTTED_QUAD " | " NUMBER " }" | |
79 | ||
80 | .ti -8 | |
81 | .IR TIME " := " NUMBER "[s|ms]" | |
82 | ||
83 | .SH DESCRIPTION | |
84 | .B tunnel | |
85 | objects are tunnels, encapsulating packets in IP packets and then | |
86 | sending them over the IP infrastructure. | |
6274b0b7 | 87 | The encapsulating (or outer) address family is specified by the |
2a9721f1 SH |
88 | .B -f |
89 | option. The default is IPv4. | |
90 | ||
61f541fe | 91 | .TP |
92 | .B ip tunnel add | |
93 | add a new tunnel | |
94 | .TP | |
95 | .B ip tunnel change | |
96 | change an existing tunnel | |
97 | .TP | |
98 | .B ip tunnel delete | |
99 | destroy a tunnel | |
100 | .RS | |
2a9721f1 SH |
101 | .TP |
102 | .BI name " NAME " (default) | |
103 | select the tunnel device name. | |
104 | ||
105 | .TP | |
106 | .BI mode " MODE" | |
107 | set the tunnel mode. Available modes depend on the encapsulating address family. | |
108 | .br | |
109 | Modes for IPv4 encapsulation available: | |
110 | .BR ipip ", " sit ", " isatap " and " gre "." | |
111 | .br | |
112 | Modes for IPv6 encapsulation available: | |
9abde37c | 113 | .BR ip6ip6 ", " ipip6 ", " ip6gre ", and " any "." |
2a9721f1 SH |
114 | |
115 | .TP | |
116 | .BI remote " ADDRESS" | |
117 | set the remote endpoint of the tunnel. | |
118 | ||
119 | .TP | |
120 | .BI local " ADDRESS" | |
121 | set the fixed local address for tunneled packets. | |
122 | It must be an address on another interface of this host. | |
123 | ||
124 | .TP | |
125 | .BI ttl " N" | |
126 | set a fixed TTL | |
127 | .I N | |
128 | on tunneled packets. | |
129 | .I N | |
130 | is a number in the range 1--255. 0 is a special value | |
131 | meaning that packets inherit the TTL value. | |
132 | The default value for IPv4 tunnels is: | |
133 | .BR "inherit" . | |
134 | The default value for IPv6 tunnels is: | |
135 | .BR "64" . | |
136 | ||
137 | ||
138 | .TP | |
139 | .BI tos " T" | |
140 | .TP | |
141 | .BI dsfield " T" | |
142 | .TP | |
143 | .BI tclass " T" | |
e59fd3db DW |
144 | set the type of service (IPv4) or traffic class (IPv6) field on |
145 | tunneled packets, which can be specified as either a two-digit | |
146 | hex value (e.g. c0) or a predefined string (e.g. internet). | |
147 | The value | |
148 | .B inherit | |
149 | causes the field to be copied from the original IP header. The | |
150 | values | |
151 | .BI "inherit/" STRING | |
152 | or | |
153 | .BI "inherit/" 00 ".." ff | |
154 | will set the field to | |
155 | .I STRING | |
156 | or | |
157 | .IR 00 ".." ff | |
158 | when tunneling non-IP packets. The default value is 00. | |
2a9721f1 SH |
159 | |
160 | .TP | |
161 | .BI dev " NAME" | |
162 | bind the tunnel to the device | |
163 | .I NAME | |
164 | so that tunneled packets will only be routed via this device and will | |
165 | not be able to escape to another device when the route to endpoint | |
166 | changes. | |
167 | ||
168 | .TP | |
169 | .B nopmtudisc | |
170 | disable Path MTU Discovery on this tunnel. | |
171 | It is enabled by default. Note that a fixed ttl is incompatible | |
6274b0b7 | 172 | with this option: tunneling with a fixed ttl always makes pmtu |
2a9721f1 SH |
173 | discovery. |
174 | ||
175 | .TP | |
176 | .BI key " K" | |
177 | .TP | |
178 | .BI ikey " K" | |
179 | .TP | |
180 | .BI okey " K" | |
181 | .RB ( " only GRE tunnels " ) | |
182 | use keyed GRE with key | |
183 | .IR K ". " K | |
184 | is either a number or an IP address-like dotted quad. | |
185 | The | |
186 | .B key | |
187 | parameter sets the key to use in both directions. | |
188 | The | |
189 | .BR ikey " and " okey | |
190 | parameters set different keys for input and output. | |
191 | ||
192 | .TP | |
193 | .BR csum ", " icsum ", " ocsum | |
194 | .RB ( " only GRE tunnels " ) | |
195 | generate/require checksums for tunneled packets. | |
196 | The | |
197 | .B ocsum | |
198 | flag calculates checksums for outgoing packets. | |
199 | The | |
200 | .B icsum | |
201 | flag requires that all input packets have the correct | |
202 | checksum. The | |
203 | .B csum | |
204 | flag is equivalent to the combination | |
205 | .BR "icsum ocsum" . | |
206 | ||
207 | .TP | |
208 | .BR seq ", " iseq ", " oseq | |
209 | .RB ( " only GRE tunnels " ) | |
210 | serialize packets. | |
211 | The | |
212 | .B oseq | |
213 | flag enables sequencing of outgoing packets. | |
214 | The | |
215 | .B iseq | |
216 | flag requires that all input packets are serialized. | |
217 | The | |
218 | .B seq | |
219 | flag is equivalent to the combination | |
220 | .BR "iseq oseq" . | |
221 | .B It isn't work. Don't use it. | |
222 | ||
2a9721f1 SH |
223 | .TP |
224 | .BI encaplim " ELIM" | |
225 | .RB ( " only IPv6 tunnels " ) | |
226 | set a fixed encapsulation limit. Default is 4. | |
227 | ||
228 | .TP | |
229 | .BI flowlabel " FLOWLABEL" | |
230 | .RB ( " only IPv6 tunnels " ) | |
231 | set a fixed flowlabel. | |
61f541fe | 232 | .RE |
2a9721f1 | 233 | |
61f541fe | 234 | .TP |
235 | .B ip tunnel prl | |
236 | potential router list (ISATAP only) | |
237 | .RS | |
2a9721f1 SH |
238 | .TP |
239 | .BI dev " NAME" | |
240 | mandatory device name. | |
241 | ||
242 | .TP | |
243 | .BI prl-default " ADDR" | |
244 | .TP | |
245 | .BI prl-nodefault " ADDR" | |
246 | .TP | |
247 | .BI prl-delete " ADDR" | |
248 | .RB "Add or delete " ADDR | |
249 | as a potential router or default router. | |
61f541fe | 250 | .RE |
2a9721f1 | 251 | |
61f541fe | 252 | .TP |
253 | .B ip tunnel show | |
254 | list tunnels | |
2a9721f1 SH |
255 | This command has no arguments. |
256 | ||
257 | .SH SEE ALSO | |
258 | .br | |
259 | .BR ip (8) | |
260 | ||
261 | .SH AUTHOR | |
262 | Original Manpage by Michail Litvak <mci@owl.openwall.com> |