1IP-TUNNEL(8) Linux IP-TUNNEL(8)
2
6 ip-tunnel - tunnel configuration
7
9 ip tunnel help
10 ip [ OPTIONS ] tunnel { add | change | del | show | prl | 6rd } [ NAME
12 ]
13 [ mode MODE ] [ remote ADDR ] [ local ADDR ]
14 [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ] ]
15 [ encaplimit ELIM ] [ ttl|hoplimit TTL ]
16 [ tos TOS ] [ flowlabel FLOWLABEL ]
17 [ prl-default ADDR ] [ prl-nodefault ADDR ] [ prl-delete ADDR ]
18 [ 6rd-prefix ADDR ] [ 6rd-relay_prefix ADDR ] [ 6rd-reset ]
19 [ [no]pmtudisc ] [ dev PHYS_DEV ]
20 MODE := { ipip | gre | sit | isatap | vti | ip6ip6 | ipip6 | ip6gre |
22 vti6 | any }
23 ADDR := { IP_ADDRESS | any }
25 TOS := { STRING | 00..ff | inherit | inherit/STRING | inherit/00..ff }
27 ELIM := { none | 0..255 }
29 TTL := { 1..255 | inherit }
31 KEY := { DOTTED_QUAD | NUMBER }
33
36 tunnel objects are tunnels, encapsulating packets in IP packets and
37 then sending them over the IP infrastructure. The encapsulating (or
38 outer) address family is specified by the -f option. The default is
39 IPv4.
40 ip tunnel add
43 add a new tunnel
44 ip tunnel change
46 change an existing tunnel
47 ip tunnel delete
49 destroy a tunnel
50 name NAME (default)
52 select the tunnel device name.
53 mode MODE
56 set the tunnel mode. Available modes depend on the encap‐
57 sulating address family.
58 Modes for IPv4 encapsulation available: ipip, sit, isa‐
59 tap, vti, and gre.
60 Modes for IPv6 encapsulation available: ip6ip6, ipip6,
61 ip6gre, vti6, and any.
62 remote ADDRESS
65 set the remote endpoint of the tunnel.
66 local ADDRESS
69 set the fixed local address for tunneled packets. It
70 must be an address on another interface of this host.
71 ttl N
74 hoplimit N
76 set a fixed TTL (IPv4) or hoplimit (IPv6) N on tunneled
77 packets. N is a number in the range 1--255. 0 is a spe‐
78 cial value meaning that packets inherit the TTL value.
79 The default value for IPv4 tunnels is: inherit. The
80 default value for IPv6 tunnels is: 64.
81 tos T
85 dsfield T
87 tclass T
89 set the type of service (IPv4) or traffic class (IPv6)
90 field on tunneled packets, which can be specified as
91 either a two-digit hex value (e.g. c0) or a predefined
92 string (e.g. internet). The value inherit causes the
93 field to be copied from the original IP header. The val‐
94 ues inherit/STRING or inherit/00..ff will set the field
95 to STRING or 00..ff when tunneling non-IP packets. The
96 default value is 00.
97 dev NAME
100 bind the tunnel to the device NAME so that tunneled pack‐
101 ets will only be routed via this device and will not be
102 able to escape to another device when the route to end‐
103 point changes.
104 nopmtudisc
107 disable Path MTU Discovery on this tunnel. It is enabled
108 by default. Note that a fixed ttl is incompatible with
109 this option: tunneling with a fixed ttl always makes pmtu
110 discovery.
111 key K
114 ikey K
116 okey K ( only GRE tunnels ) use keyed GRE with key K. K is
118 either a number or an IP address-like dotted quad. The
119 key parameter sets the key to use in both directions.
120 The ikey and okey parameters set different keys for input
121 and output.
122 csum, icsum, ocsum
125 ( only GRE tunnels ) generate/require checksums for tun‐
126 neled packets. The ocsum flag calculates checksums for
127 outgoing packets. The icsum flag requires that all input
128 packets have the correct checksum. The csum flag is
129 equivalent to the combination icsum ocsum.
130 seq, iseq, oseq
133 ( only GRE tunnels ) serialize packets. The oseq flag
134 enables sequencing of outgoing packets. The iseq flag
135 requires that all input packets are serialized. The seq
136 flag is equivalent to the combination iseq oseq. It
137 doesn't work. Don't use it.
138 encaplim ELIM
141 ( only IPv6 tunnels ) set a fixed encapsulation limit.
142 Default is 4.
143 flowlabel FLOWLABEL
146 ( only IPv6 tunnels ) set a fixed flowlabel.
147 ip tunnel prl
150 potential router list (ISATAP only)
151 dev NAME
153 mandatory device name.
154 prl-default ADDR
157 prl-nodefault ADDR
159 prl-delete ADDR
161 Add or delete ADDR as a potential router or default
162 router.
163 ip tunnel show
166 list tunnels This command has no arguments.
167
170 ip(8)
171
174 Original Manpage by Michail Litvak <mci@owl.openwall.com>
175iproute2 20 Dec 2011 IP-TUNNEL(8)