man-pages/man8/ip-tunnel.8.html
2021-03-31 01:06:50 +01:00

462 lines
7.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of IP-TUNNEL</TITLE>
</HEAD><BODY>
<H1>IP-TUNNEL</H1>
Section: Linux (8)<BR>Updated: 20 Dec 2011<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
ip-tunnel - tunnel configuration
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<BR>
<B>ip tunnel help</B>
<P>
<BR>
<B>ip </B>
[ <I>OPTIONS</I> ]
<B>tunnel</B> { <B>add</B> | <B>change</B> | <B>del</B> | <B>show</B> | <B>prl</B> | <B>6rd</B> }
[ <I>NAME</I> ]
<BR>
[ <B>mode</B>
<I>MODE</I> ] [
<B>remote</B>
<I>ADDR</I> ] [
<B>local</B>
<I>ADDR</I> ]
<BR>
[ [<B>i</B>|<B>o</B>]<B>seq</B> ] [ [<B>i</B>|<B>o</B>]<B>key</B>
<I>KEY</I> ] [
[<B>i</B>|<B>o</B>]<B>csum</B> ] ]
<BR>
[ <B>encaplimit</B>
<I>ELIM</I> ]
[ <B>ttl</B>|<B>hoplimit</B>
<I>TTL</I> ]
<BR>
[ <B>tos</B>
<I>TOS</I> ] [
<B>flowlabel</B>
<I>FLOWLABEL</I> ]
<BR>
[ <B>prl-default</B>
<I>ADDR</I> ] [
<B>prl-nodefault</B>
<I>ADDR</I> ] [
<B>prl-delete</B>
<I>ADDR</I> ]
<BR>
[ <B>6rd-prefix</B>
<I>ADDR</I> ] [
<B>6rd-relay_prefix</B>
<I>ADDR</I> ] [
<B>6rd-reset</B> ]
<BR>
[ [<B>no</B>]<B>pmtudisc</B> ]
[ [<B>no</B>]<B>ignore-df</B> ]
[ [<B>no</B>]<B>allow-localremote</B> ]
<BR>
[ <B>dev</B>
<I>PHYS_DEV</I> ]
<P>
<BR>
<I>MODE</I> :=
{ <B>ipip</B> | <B>gre</B> | <B>sit</B> | <B>isatap</B> | <B>vti</B> | <B>ip6ip6</B> | <B>ipip6</B> | <B>ip6gre</B> | <B>vti6</B> | <B>any</B> }
<P>
<BR>
<I>ADDR</I> := { <I>IP_ADDRESS</I> |
<B>any</B> }
<P>
<BR>
<I>TOS</I> := { <I>STRING</I> | <I>00</I>..<I>ff</I> |
<B>inherit</B> |
<B>inherit/</B><I>STRING</I>
|
<B>inherit/</B><I>00</I><B>..</B><I>ff</I>
}
<P>
<BR>
<I>ELIM</I> := {
<B>none</B> |
<I>0</I>..<I>255</I> }
<P>
<BR>
<BR>
<I>TTL</I> := { <I>1</I>..<I>255</I> |
<B>inherit</B> }
<P>
<BR>
<I>KEY</I> := { <I>DOTTED_QUAD</I> | <I>NUMBER</I> }
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>tunnel</B>
objects are tunnels, encapsulating packets in IP packets and then
sending them over the IP infrastructure.
The encapsulating (or outer) address family is specified by the
<B>-f</B>
option. The default is IPv4.
<P>
<DL COMPACT>
<DT id="1"><B>ip tunnel add</B>
<DD>
add a new tunnel
<DT id="2"><B>ip tunnel change</B>
<DD>
change an existing tunnel
<DT id="3"><B>ip tunnel delete</B>
<DD>
destroy a tunnel
<DL COMPACT><DT id="4"><DD>
<DL COMPACT>
<DT id="5"><B>name</B><I> NAME </I><B>(default)</B>
<DD>
select the tunnel device name.
<P>
<DT id="6"><B>mode</B><I> MODE</I>
<DD>
set the tunnel mode. Available modes depend on the encapsulating address family.
<BR>
Modes for IPv4 encapsulation available:
<B>ipip</B>, <B>sit</B>, <B>isatap</B>, <B>vti</B>, and <B>gre</B>.
<BR>
Modes for IPv6 encapsulation available:
<B>ip6ip6</B>, <B>ipip6</B>, <B>ip6gre</B>, <B>vti6</B>, and <B>any</B>.
<P>
<DT id="7"><B>remote</B><I> ADDRESS</I>
<DD>
set the remote endpoint of the tunnel.
<P>
<DT id="8"><B>local</B><I> ADDRESS</I>
<DD>
set the fixed local address for tunneled packets.
It must be an address on another interface of this host.
<P>
<DT id="9"><B>ttl</B><I> N</I>
<DD>
<DT id="10"><B>hoplimit</B><I> N</I>
<DD>
set a fixed TTL (IPv4) or hoplimit (IPv6)
<I>N</I>
on tunneled packets.
<I>N</I>
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:
<B>inherit</B>.
The default value for IPv6 tunnels is:
<B>64</B>.
<P>
<P>
<DT id="11"><B>tos</B><I> T</I>
<DD>
<DT id="12"><B>dsfield</B><I> T</I>
<DD>
<DT id="13"><B>tclass</B><I> T</I>
<DD>
set the type of service (IPv4) or traffic class (IPv6) field on
tunneled packets, which can be specified as either a two-digit
hex value (e.g. c0) or a predefined string (e.g. internet).
The value
<B>inherit</B>
causes the field to be copied from the original IP header. The
values
<B>inherit/</B><I>STRING</I>
or
<B>inherit/</B><I>00</I><B>..</B><I>ff</I>
will set the field to
<I>STRING</I>
or
<I>00</I>..<I>ff</I>
when tunneling non-IP packets. The default value is 00.
<P>
<DT id="14"><B>dev</B><I> NAME</I>
<DD>
bind the tunnel to the device
<I>NAME</I>
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.
<P>
<DT id="15"><B>nopmtudisc</B>
<DD>
disable Path MTU Discovery on this tunnel.
It is enabled by default. Note that a fixed ttl is incompatible
with this option: tunneling with a fixed ttl always makes pmtu
discovery.
<P>
<DT id="16"><B>ignore-df</B>
<DD>
enable IPv4 DF suppression on this tunnel.
Normally datagrams that exceed the MTU will be fragmented; the presence
of the DF flag inhibits this, resulting instead in an ICMP Unreachable
(Fragmentation Required) message. Enabling this attribute causes the
DF flag to be ignored.
<P>
<DT id="17"><B>key</B><I> K</I>
<DD>
<DT id="18"><B>ikey</B><I> K</I>
<DD>
<DT id="19"><B>okey</B><I> K</I>
<DD>
(<B> only GRE tunnels </B>)
use keyed GRE with key
<I>K</I>. <I>K</I>
is either a number or an IP address-like dotted quad.
The
<B>key</B>
parameter sets the key to use in both directions.
The
<B>ikey</B> and <B>okey</B>
parameters set different keys for input and output.
<P>
<DT id="20"><B>csum</B>, <B>icsum</B>, <B>ocsum</B>
<DD>
(<B> only GRE tunnels </B>)
generate/require checksums for tunneled packets.
The
<B>ocsum</B>
flag calculates checksums for outgoing packets.
The
<B>icsum</B>
flag requires that all input packets have the correct
checksum. The
<B>csum</B>
flag is equivalent to the combination
<B>icsum ocsum</B>.
<P>
<DT id="21"><B>seq</B>, <B>iseq</B>, <B>oseq</B>
<DD>
(<B> only GRE tunnels </B>)
serialize packets.
The
<B>oseq</B>
flag enables sequencing of outgoing packets.
The
<B>iseq</B>
flag requires that all input packets are serialized.
The
<B>seq</B>
flag is equivalent to the combination
<B>iseq oseq</B>.
<B>It doesn't work. Don't use it.</B>
<P>
<DT id="22"><B>encaplim</B><I> ELIM</I>
<DD>
(<B> only IPv6 tunnels </B>)
set a fixed encapsulation limit. Default is 4.
<P>
<DT id="23"><B>flowlabel</B><I> FLOWLABEL</I>
<DD>
(<B> only IPv6 tunnels </B>)
set a fixed flowlabel.
<P>
<DT id="24"><B>allow-localremote</B>
<DD>
(<B> only IPv6 tunnels </B>)
allow remote endpoint on the local host.
</DL>
</DL>
<P>
<DT id="25"><B>ip tunnel prl</B>
<DD>
potential router list (ISATAP only)
<DL COMPACT><DT id="26"><DD>
<DL COMPACT>
<DT id="27"><B>dev</B><I> NAME</I>
<DD>
mandatory device name.
<P>
<DT id="28"><B>prl-default</B><I> ADDR</I>
<DD>
<DT id="29"><B>prl-nodefault</B><I> ADDR</I>
<DD>
<DT id="30"><B>prl-delete</B><I> ADDR</I>
<DD>
Add or delete <B>ADDR</B>
as a potential router or default router.
</DL>
</DL>
<P>
<DT id="31"><B>ip tunnel show</B>
<DD>
list tunnels
This command has no arguments.
<P>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>SEE ALSO</H2>
<BR>
<B><A HREF="/cgi-bin/man/man2html?8+ip">ip</A></B>(8)
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>AUTHOR</H2>
Original Manpage by Michail Litvak &lt;<A HREF="mailto:mci@owl.openwall.com">mci@owl.openwall.com</A>&gt;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="32"><A HREF="#lbAB">NAME</A><DD>
<DT id="33"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="34"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="35"><A HREF="#lbAE">SEE ALSO</A><DD>
<DT id="36"><A HREF="#lbAF">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:13 GMT, March 31, 2021
</BODY>
</HTML>