{
"content": [
{
"type": "text",
"text": "# iptunnel(8) (man)\n\n**Summary:** iptunnel - Create and manage IP tunnels\n\n**Synopsis:** iptunnel { add | change | del | show } [ NAME ]\n[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n[ ttl TTL ] [ tos TOS ] [ nopmtudisc ] [ dev PHYSDEV ]\niptunnel -V | --version\nWhere: NAME := STRING\nADDR := { IPADDRESS | any }\nTOS := { NUMBER | inherit }\nTTL := { 1..255 | inherit }\nKEY := { DOTTEDQUAD | NUMBER }\n\n## Section Outline\n\n- **NAME** (3 lines)\n- **SYNOPSIS** (14 lines)\n- **DESCRIPTION** (3 lines)\n- **OPTIONS** (6 lines) — 9 subsections\n - { add | change | del } [ NAME ] (4 lines)\n - mode PROTOCOL (4 lines)\n - remote ADDR (4 lines)\n - local ADDR (11 lines)\n - ikey KEY (4 lines)\n - okey KEY (10 lines)\n - ttl TTL (5 lines)\n - tos TOS (5 lines)\n - nopmtudisc (8 lines)\n- **HOMEPAGE** (1 lines) — 1 subsections\n - (1 lines)\n- **AUTHORS** (11 lines)\n\n## Full Content\n\n### NAME\n\niptunnel - Create and manage IP tunnels\n\n### SYNOPSIS\n\niptunnel { add | change | del | show } [ NAME ]\n[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n[ ttl TTL ] [ tos TOS ] [ nopmtudisc ] [ dev PHYSDEV ]\n\niptunnel -V | --version\n\nWhere: NAME := STRING\nADDR := { IPADDRESS | any }\nTOS := { NUMBER | inherit }\nTTL := { 1..255 | inherit }\nKEY := { DOTTEDQUAD | NUMBER }\n\n### DESCRIPTION\n\niptunnel can be used to add, change, delete and show IP tunnels on the machine.\n\n### OPTIONS\n\nhelp Show the help text.\n\n\nshow List existing IP tunnels.\n\n#### { add | change | del } [ NAME ]\n\nSpecify an action (add, change or delete an IP tunnel) to be executed by iptunnel on\nthe tunnel named NAME, which must be a string. You must specify one action.\n\n#### mode PROTOCOL\n\nSpecify the PROTOCOL to be used for the IP tunnel. It can be ipip for TCP/IP, gre for\nCisco GRE tunnel (RFCs 1701 and 1702), or sit for IPv6-in-IPv4 tunneling.\n\n#### remote ADDR\n\nSet the remote (i.e., destination) address of the tunnel. ADDR must be an IP address\nor the word any.\n\n#### local ADDR\n\nSet the local (i.e., source) address of the tunnel. ADDR must be an IP address or the\nword any.\n\n\niseq Require that all incoming packets are serialized. Only applicable for GRE tunnels.\n\n\noseq Enable serialization (sequencing) for all outgoing packets. Only applicable for GRE\ntunnels.\n\n#### ikey KEY\n\nSpecify the input key for the Cisco GRE tunnel. KEY must be either in dotted quad\n(dotted decimal) or a number. Only applicable for GRE tunnels.\n\n#### okey KEY\n\nSame as ikey, but set the output key instead. Only applicable for GRE tunnels.\n\n\nicsum Require that all incoming packets have the correct checksum. Only applicable for GRE\ntunnels.\n\n\nocsum Calculate checksums for all outgoing packets. Only applicable for GRE tunnels.\n\n#### ttl TTL\n\nSpecify the Time-To-Live value for the IP tunnel. TTL must be a value between 1 and\n255, or the word inherit, which causes the field to be copied from the original IP\nheader.\n\n#### tos TOS\n\nSpecify the Type-Of-Service value for the IP tunnel. TOS must be a value between 1\nand 255, or the word inherit, which causes the field to be copied from the original IP\nheader.\n\n#### nopmtudisc\n\nDisable Path MTU Discovery on this tunnel. Note that a fixed ttl is incompatible with\nthis option.\n\n\ndev PHYSDEV\nBind the tunnel to the device PHYSDEV.\n\n### HOMEPAGE\n\n#### \n\n### AUTHORS\n\nThis manpage was written by Sergio Durigan Junior . A few\nparts were inspired by ip-tunnel(1)'s manpage.\n\n\nPermission is granted to copy, distribute and/or modify this document under the terms of the\nGNU General Public License, Version 2 or any later version published by the Free Software\nFoundation.\n\n\n\nFebruary 2018 version 1.60 IPTUNNEL(8)\n\n"
}
],
"structuredContent": {
"command": "iptunnel",
"section": "8",
"mode": "man",
"summary": "iptunnel - Create and manage IP tunnels",
"synopsis": "iptunnel { add | change | del | show } [ NAME ]\n[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n[ ttl TTL ] [ tos TOS ] [ nopmtudisc ] [ dev PHYSDEV ]\niptunnel -V | --version\nWhere: NAME := STRING\nADDR := { IPADDRESS | any }\nTOS := { NUMBER | inherit }\nTTL := { 1..255 | inherit }\nKEY := { DOTTEDQUAD | NUMBER }",
"flags": [],
"examples": [],
"see_also": [],
"section_outline": [
{
"name": "NAME",
"lines": 3,
"subsections": []
},
{
"name": "SYNOPSIS",
"lines": 14,
"subsections": []
},
{
"name": "DESCRIPTION",
"lines": 3,
"subsections": []
},
{
"name": "OPTIONS",
"lines": 6,
"subsections": [
{
"name": "{ add | change | del } [ NAME ]",
"lines": 4
},
{
"name": "mode PROTOCOL",
"lines": 4
},
{
"name": "remote ADDR",
"lines": 4
},
{
"name": "local ADDR",
"lines": 11
},
{
"name": "ikey KEY",
"lines": 4
},
{
"name": "okey KEY",
"lines": 10
},
{
"name": "ttl TTL",
"lines": 5
},
{
"name": "tos TOS",
"lines": 5
},
{
"name": "nopmtudisc",
"lines": 8
}
]
},
{
"name": "HOMEPAGE",
"lines": 1,
"subsections": [
{
"name": "",
"lines": 1
}
]
},
{
"name": "AUTHORS",
"lines": 11,
"subsections": []
}
]
}
}