[mirror_iproute2.git] / man / man8 / ip-tunnel.8

.TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux"
.SH "NAME"
ip-tunnel - tunnel configuration
.SH "SYNOPSIS"
.sp
.ad l
.in +8
.ti -8
.B ip
.RI "[ " OPTIONS " ]"
.B tunnel
.RI " { " COMMAND " | "
.BR help " }"
.sp
.ti -8
.BR "ip tunnel" " { " add " | " change " | " del " | " show " | " prl " }"
.RI "[ " NAME " ]"
.br
.RB "[ " mode
.IR MODE " ] [ "
.B remote
.IR ADDR " ] [ "
.B  local
.IR ADDR " ]"
.br
.RB "[ [" i "|" o "]" seq " ] [ [" i "|" o "]" key
.IR KEY " ] [ "
.RB "[" i "|" o "]" csum " ] ]"
.br
.RB "[ " encaplimit
.IR ELIM " ]"
.RB "[ " ttl
.IR TTL " ]"
.br
.RB "[ " tos
.IR TOS " ] [ "
.B flowlabel
.IR FLOWLABEL " ]"
.br
.RB "[ " prl-default
.IR ADDR " ] [ "
.B prl-nodefault
.IR ADDR " ] [ "
.B prl-delete
.IR ADDR " ]"
.br
.RB "[ [" no "]" pmtudisc " ]"
.RB "[ " dev
.IR PHYS_DEV " ]"
.RB "[ " "dscp inherit" " ]"

.ti -8
.IR MODE " := "
.RB " { " ipip " | " gre " | " sit " | " isatap " | " ip6ip6 " | " ipip6 " | " any " }"

.ti -8
.IR ADDR " := { " IP_ADDRESS " |"
.BR any " }"

.ti -8
.IR TOS " := { " NUMBER " |"
.BR inherit " }"

.ti -8
.IR ELIM " := {"
.BR none " | "
.IR 0 ".." 255 " }"

.ti -8
.ti -8
.IR TTL " := { " 1 ".." 255 " | "
.BR inherit " }"

.ti -8
.IR KEY " := { " DOTTED_QUAD " | " NUMBER " }"

.ti -8
.IR TIME " := " NUMBER "[s|ms]"

.SH DESCRIPTION
.B tunnel
objects are tunnels, encapsulating packets in IP packets and then
sending them over the IP infrastructure.
The encapulating (or outer) address family is specified by the
.B -f
option.  The default is IPv4.

.SS ip tunnel add - add a new tunnel
.SS ip tunnel change - change an existing tunnel
.SS ip tunnel delete - destroy a tunnel

.TP
.BI name " NAME " (default)
select the tunnel device name.

.TP
.BI mode " MODE"
set the tunnel mode. Available modes depend on the encapsulating address family.
.br
Modes for IPv4 encapsulation available:
.BR ipip ", " sit ", " isatap " and " gre "."
.br
Modes for IPv6 encapsulation available:
.BR ip6ip6 ", " ipip6 " and " any "."

.TP
.BI remote " ADDRESS"
set the remote endpoint of the tunnel.

.TP
.BI local " ADDRESS"
set the fixed local address for tunneled packets.
It must be an address on another interface of this host.

.TP
.BI ttl " N"
set a fixed TTL
.I N
on tunneled packets.
.I N
is a number in the range 1--255. 0 is a special value
meaning that packets inherit the TTL value.
The default value for IPv4 tunnels is:
.BR "inherit" .
The default value for IPv6 tunnels is:
.BR "64" .


.TP
.BI tos " T"
.TP
.BI dsfield " T"
.TP
.BI tclass " T"
set a fixed TOS (or traffic class in IPv6)
.I T
on tunneled packets.
The default value is:
.BR "inherit" .

.TP
.BI dev " NAME"
bind the tunnel to the device
.I NAME
so that tunneled packets will only be routed via this device and will
not be able to escape to another device when the route to endpoint
changes.

.TP
.B nopmtudisc
disable Path MTU Discovery on this tunnel.
It is enabled by default.  Note that a fixed ttl is incompatible
with this option: tunnelling with a fixed ttl always makes pmtu
discovery.

.TP
.BI key " K"
.TP
.BI ikey " K"
.TP
.BI okey " K"
.RB ( " only GRE tunnels " )
use keyed GRE with key
.IR K ". " K
is either a number or an IP address-like dotted quad.
The
.B key
parameter sets the key to use in both directions.
The
.BR ikey " and " okey
parameters set different keys for input and output.

.TP
.BR csum ", " icsum ", " ocsum
.RB ( " only GRE tunnels " )
generate/require checksums for tunneled packets.
The
.B ocsum
flag calculates checksums for outgoing packets.
The
.B icsum
flag requires that all input packets have the correct
checksum.  The
.B csum
flag is equivalent to the combination
.BR "icsum ocsum" .

.TP
.BR seq ", " iseq ", " oseq
.RB ( " only GRE tunnels " )
serialize packets.
The
.B oseq
flag enables sequencing of outgoing packets.
The
.B iseq
flag requires that all input packets are serialized.
The
.B  seq
flag is equivalent to the combination
.BR "iseq oseq" .
.B It isn't work. Don't use it.

.TP
.BR "dscp inherit"
.RB ( " only IPv6 tunnels " )
Inherit DS field between inner and outer header.

.TP
.BI encaplim " ELIM"
.RB ( " only IPv6 tunnels " )
set a fixed encapsulation limit.  Default is 4.

.TP
.BI flowlabel " FLOWLABEL"
.RB ( " only IPv6 tunnels " )
set a fixed flowlabel.

.SS ip tunnel prl - potential router list (ISATAP only)

.TP
.BI dev " NAME"
mandatory device name.

.TP
.BI prl-default " ADDR"
.TP
.BI prl-nodefault " ADDR"
.TP
.BI prl-delete " ADDR"
.RB "Add or delete " ADDR
as a potential router or default router.

.SS ip tunnel show - list tunnels
This command has no arguments.

.SH SEE ALSO
.br
.BR ip (8)

.SH AUTHOR
Original Manpage by Michail Litvak <mci@owl.openwall.com>
Commit	Line	Data
2a9721f1 SH	1	.TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux"
2a9721f1 SH	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 " ]"
	50	.RB "[ " "dscp inherit" " ]"
	51
	52	.ti -8
	53	.IR MODE " := "
	54	.RB " { " ipip " \| " gre " \| " sit " \| " isatap " \| " ip6ip6 " \| " ipip6 " \| " any " }"
	55
	56	.ti -8
	57	.IR ADDR " := { " IP_ADDRESS " \|"
	58	.BR any " }"
	59
	60	.ti -8
	61	.IR TOS " := { " NUMBER " \|"
	62	.BR inherit " }"
	63
	64	.ti -8
	65	.IR ELIM " := {"
	66	.BR none " \| "
	67	.IR 0 ".." 255 " }"
68
69	.ti -8
70	.ti -8
71	.IR TTL " := { " 1 ".." 255 " \| "
72	.BR inherit " }"
73
74	.ti -8
75	.IR KEY " := { " DOTTED_QUAD " \| " NUMBER " }"
76
77	.ti -8
78	.IR TIME " := " NUMBER "[s\|ms]"
79
80	.SH DESCRIPTION
81	.B tunnel
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
85	.B -f
86	option. The default is IPv4.
87
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
91
92	.TP
93	.BI name " NAME " (default)
94	select the tunnel device name.
95
96	.TP
97	.BI mode " MODE"
98	set the tunnel mode. Available modes depend on the encapsulating address family.
99	.br
100	Modes for IPv4 encapsulation available:
101	.BR ipip ", " sit ", " isatap " and " gre "."
102	.br
103	Modes for IPv6 encapsulation available:
104	.BR ip6ip6 ", " ipip6 " and " any "."
105
106	.TP
107	.BI remote " ADDRESS"
108	set the remote endpoint of the tunnel.
109
110	.TP
111	.BI local " ADDRESS"
112	set the fixed local address for tunneled packets.
113	It must be an address on another interface of this host.
114
115	.TP
116	.BI ttl " N"
117	set a fixed TTL
118	.I N
119	on tunneled packets.
120	.I N
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:
124	.BR "inherit" .
125	The default value for IPv6 tunnels is:
126	.BR "64" .
127
128
129	.TP
130	.BI tos " T"
131	.TP
132	.BI dsfield " T"
133	.TP
134	.BI tclass " T"
135	set a fixed TOS (or traffic class in IPv6)
136	.I T
137	on tunneled packets.
138	The default value is:
139	.BR "inherit" .
140
141	.TP
142	.BI dev " NAME"
143	bind the tunnel to the device
144	.I NAME
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
147	changes.
148
149	.TP
150	.B nopmtudisc
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
154	discovery.
155
156	.TP
157	.BI key " K"
158	.TP
159	.BI ikey " K"
160	.TP
161	.BI okey " K"
162	.RB ( " only GRE tunnels " )
163	use keyed GRE with key
164	.IR K ". " K
165	is either a number or an IP address-like dotted quad.
166	The
167	.B key
168	parameter sets the key to use in both directions.
169	The
170	.BR ikey " and " okey
171	parameters set different keys for input and output.
172
173	.TP
174	.BR csum ", " icsum ", " ocsum
175	.RB ( " only GRE tunnels " )
176	generate/require checksums for tunneled packets.
177	The
178	.B ocsum
179	flag calculates checksums for outgoing packets.
180	The
181	.B icsum
182	flag requires that all input packets have the correct
183	checksum. The
184	.B csum
185	flag is equivalent to the combination
186	.BR "icsum ocsum" .
187
188	.TP
189	.BR seq ", " iseq ", " oseq
190	.RB ( " only GRE tunnels " )
191	serialize packets.
192	The
193	.B oseq
194	flag enables sequencing of outgoing packets.
195	The
196	.B iseq
197	flag requires that all input packets are serialized.
198	The
199	.B seq
200	flag is equivalent to the combination
201	.BR "iseq oseq" .
202	.B It isn't work. Don't use it.
203
204	.TP
205	.BR "dscp inherit"
206	.RB ( " only IPv6 tunnels " )
207	Inherit DS field between inner and outer header.
208
209	.TP
210	.BI encaplim " ELIM"
211	.RB ( " only IPv6 tunnels " )
212	set a fixed encapsulation limit. Default is 4.
213
214	.TP
215	.BI flowlabel " FLOWLABEL"
216	.RB ( " only IPv6 tunnels " )
217	set a fixed flowlabel.
218
219	.SS ip tunnel prl - potential router list (ISATAP only)
220
221	.TP
222	.BI dev " NAME"
223	mandatory device name.
224
225	.TP
226	.BI prl-default " ADDR"
227	.TP
228	.BI prl-nodefault " ADDR"
229	.TP
230	.BI prl-delete " ADDR"
231	.RB "Add or delete " ADDR
232	as a potential router or default router.
233
234	.SS ip tunnel show - list tunnels
235	This command has no arguments.
236
237	.SH SEE ALSO
238	.br
239	.BR ip (8)
240
241	.SH AUTHOR
242	Original Manpage by Michail Litvak <mci@owl.openwall.com>