| 1 |
.\" Hey, EMACS: -*- nroff -*- |
| 2 |
.\" Copyright (C) 2018 Sergio Durigan Junior <[email protected]> |
| 3 |
.\" |
| 4 |
.\" This program is free software; you can redistribute it and/or |
| 5 |
.\" modify it under the terms of the GNU General Public License |
| 6 |
.\" as published by the Free Software Foundation; either version |
| 7 |
.\" 2 of the License, or (at your option) any later version. |
| 8 |
.\" |
| 9 |
.\" $Id$ |
| 10 |
.TH IPTUNNEL 8 "version 1.60" "February 2018" |
| 11 |
.\" Please adjust this date whenever revising the manpage. |
| 12 |
.\" |
| 13 |
|
| 14 |
.SH NAME |
| 15 |
|
| 16 |
iptunnel \- Create and manage IP tunnels |
| 17 |
|
| 18 |
.SH SYNOPSIS |
| 19 |
.B iptunnel |
| 20 |
{ add | change | del | show } [ NAME ] |
| 21 |
[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] |
| 22 |
[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ] |
| 23 |
[ ttl TTL ] [ tos TOS ] [ nopmtudisc ] [ dev PHYS_DEV ] |
| 24 |
|
| 25 |
.B iptunnel |
| 26 |
\-V | \-\-version |
| 27 |
|
| 28 |
\fBWhere\fP: NAME := STRING |
| 29 |
ADDR := { IP_ADDRESS | any } |
| 30 |
TOS := { NUMBER | inherit } |
| 31 |
TTL := { 1..255 | inherit } |
| 32 |
KEY := { DOTTED_QUAD | NUMBER } |
| 33 |
|
| 34 |
.SH DESCRIPTION |
| 35 |
|
| 36 |
\fBiptunnel\fP can be used to add, change, delete and show IP tunnels |
| 37 |
on the machine. |
| 38 |
|
| 39 |
.SH OPTIONS |
| 40 |
|
| 41 |
.TP |
| 42 |
.B help |
| 43 |
Show the help text. |
| 44 |
|
| 45 |
.TP |
| 46 |
.B show |
| 47 |
List existing IP tunnels. |
| 48 |
|
| 49 |
.TP |
| 50 |
.B { add | change | del } [ NAME ] |
| 51 |
Specify an action (\fBadd\fP, \fBchange\fP or \fBdelete\fP an IP |
| 52 |
tunnel) to be executed by \fBiptunnel\fP on the tunnel named |
| 53 |
\fBNAME\fP, which must be a string. You must specify one action. |
| 54 |
|
| 55 |
.TP |
| 56 |
.B mode PROTOCOL |
| 57 |
Specify the \fBPROTOCOL\fP to be used for the IP tunnel. It can be |
| 58 |
\fBipip\fP for TCP/IP, \fBgre\fP for Cisco GRE tunnel (RFCs 1701 and |
| 59 |
1702), or \fBsit\fP for IPv6-in-IPv4 tunneling. |
| 60 |
|
| 61 |
.TP |
| 62 |
.B remote ADDR |
| 63 |
Set the remote (i.e., destination) address of the tunnel. \fBADDR\fP |
| 64 |
must be an IP address or the word \fBany\fP. |
| 65 |
|
| 66 |
.TP |
| 67 |
.B local ADDR |
| 68 |
Set the local (i.e., source) address of the tunnel. \fBADDR\fP must |
| 69 |
be an IP address or the word \fBany\fP. |
| 70 |
|
| 71 |
.TP |
| 72 |
.B iseq |
| 73 |
Require that all incoming packets are serialized. Only applicable for |
| 74 |
\fBGRE\fP tunnels. |
| 75 |
|
| 76 |
.TP |
| 77 |
.B oseq |
| 78 |
Enable serialization (sequencing) for all outgoing packets. Only |
| 79 |
applicable for \fBGRE\fP tunnels. |
| 80 |
|
| 81 |
.TP |
| 82 |
.B ikey KEY |
| 83 |
Specify the input key for the Cisco GRE tunnel. \fBKEY\fP must be |
| 84 |
either in dotted quad (dotted decimal) or a number. Only applicable |
| 85 |
for \fBGRE\fP tunnels. |
| 86 |
|
| 87 |
.TP |
| 88 |
.B okey KEY |
| 89 |
Same as \fBikey\fP, but set the output key instead. Only applicable |
| 90 |
for \fBGRE\fP tunnels. |
| 91 |
|
| 92 |
.TP |
| 93 |
.B icsum |
| 94 |
Require that all incoming packets have the correct checksum. Only |
| 95 |
applicable for \fBGRE\fP tunnels. |
| 96 |
|
| 97 |
.TP |
| 98 |
.B ocsum |
| 99 |
Calculate checksums for all outgoing packets. Only applicable for |
| 100 |
\fBGRE\fP tunnels. |
| 101 |
|
| 102 |
.TP |
| 103 |
.B ttl TTL |
| 104 |
Specify the \fBTime-To-Live\fP value for the IP tunnel. \fBTTL\fP |
| 105 |
must be a value between \fB1\fP and \fB255\fP, or the word |
| 106 |
\fBinherit\fP, which causes the field to be copied from the original |
| 107 |
IP header. |
| 108 |
|
| 109 |
.TP |
| 110 |
.B tos TOS |
| 111 |
Specify the \fBType-Of-Service\fP value for the IP tunnel. \fBTOS\fP |
| 112 |
must be a value between \fB1\fP and \fB255\fP, or the word |
| 113 |
\fBinherit\fP, which causes the field to be copied from the original |
| 114 |
IP header. |
| 115 |
|
| 116 |
.TP |
| 117 |
.B nopmtudisc |
| 118 |
Disable \fBPath MTU Discovery\fP on this tunnel. Note that a fixed |
| 119 |
\fBttl\fP is incompatible with this option. |
| 120 |
|
| 121 |
.TP |
| 122 |
.B dev PHYS_DEV |
| 123 |
Bind the tunnel to the device \fBPHYS_DEV\fP. |
| 124 |
|
| 125 |
.SH HOMEPAGE |
| 126 |
|
| 127 |
\fB<https://sourceforge.net/projects/net-tools/>\fP |
| 128 |
|
| 129 |
.SH AUTHORS |
| 130 |
|
| 131 |
This manpage was written by Sergio Durigan Junior <sergiodj (at) |
| 132 |
sergiodj (dot) net>. A few parts were inspired by |
| 133 |
\fBip-tunnel(1)\fP's manpage. |
| 134 |
|
| 135 |
.PP |
| 136 |
Permission is granted to copy, distribute and/or modify this document under the |
| 137 |
terms of the GNU General Public License, Version 2 or any later version published |
| 138 |
by the Free Software Foundation. |