logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

ip-tunnel.8 (5592B)

    

  1. .TH IP\-TUNNEL 8 "20 Dec 2011" "iproute2" "Linux"
  2. .SH "NAME"
  3. ip-tunnel - tunnel configuration
  4. .SH "SYNOPSIS"
  5. .sp
  6. .ad l
  7. .in +8
  8. .ti -8
  9. .B ip tunnel help
  10. .sp
  11. .ti -8
  12. .BR "ip "
  13. .RI "[ " OPTIONS " ]"
  14. .BR "tunnel" " { " add " | " change " | " del " | " show " | " prl " | " 6rd " }"
  15. .RI "[ " NAME " ]"
  16. .br
  17. .RB "[ " mode
  18. .IR MODE " ] [ "
  19. .B remote
  20. .IR ADDR " ] [ "
  21. .B  local
  22. .IR ADDR " ]"
  23. .br
  24. .RB "[ [" i "|" o "]" seq " ] [ [" i "|" o "]" key
  25. .IR KEY " ] [ "
  26. .RB "[" i "|" o "]" csum " ] ]"
  27. .br
  28. .RB "[ " encaplimit
  29. .IR ELIM " ]"
  30. .RB "[ " ttl "|" hoplimit
  31. .IR TTL " ]"
  32. .br
  33. .RB "[ " tos
  34. .IR TOS " ] [ "
  35. .B flowlabel
  36. .IR FLOWLABEL " ]"
  37. .br
  38. .RB "[ " prl-default
  39. .IR ADDR " ] [ "
  40. .B prl-nodefault
  41. .IR ADDR " ] [ "
  42. .B prl-delete
  43. .IR ADDR " ]"
  44. .br
  45. .RB "[ " 6rd-prefix
  46. .IR ADDR " ] ["
  47. .B 6rd-relay_prefix
  48. .IR ADDR " ] [
  49. .BR 6rd-reset " ]"
  50. .br
  51. .RB "[ [" no "]" pmtudisc " ]"
  52. .RB "[ [" no "]" ignore-df " ]"
  53. .RB "[ [" no "]" allow-localremote " ]"
  54. .br
  55. .RB "[ " dev
  56. .IR PHYS_DEV " ]"
  58. .ti -8
  59. .IR MODE " := "
  60. .RB " { " ipip " | " gre " | " sit " | " isatap " | " vti " | " ip6ip6 " | " ipip6 " | " ip6gre " | " vti6 " | " any " }"
  62. .ti -8
  63. .IR ADDR " := { " IP_ADDRESS " |"
  64. .BR any " }"
  66. .ti -8
  67. .IR TOS " := { " STRING " | " 00 ".." ff " |"
  68. .BR inherit " |"
  69. .BI "inherit/" STRING
  70. .RB "|"
  71. .BI "inherit/" 00 ".." ff
  72. .RB "}"
  74. .ti -8
  75. .IR ELIM " := {"
  76. .BR none " | "
  77. .IR 0 ".." 255 " }"
  79. .ti -8
  80. .ti -8
  81. .IR TTL " := { " 1 ".." 255 " | "
  82. .BR inherit " }"
  84. .ti -8
  85. .IR KEY " := { " DOTTED_QUAD " | " NUMBER " }"
  87. .SH DESCRIPTION
  88. .B tunnel
  89. objects are tunnels, encapsulating packets in IP packets and then
  90. sending them over the IP infrastructure.
  91. The encapsulating (or outer) address family is specified by the
  92. .B -f
  93. option. The default is IPv4.
  95. .TP
  96. .B ip tunnel add
  97. add a new tunnel
  98. .TP
  99. .B ip tunnel change
  100. change an existing tunnel
  101. .TP
  102. .B ip tunnel delete
  103. destroy a tunnel
  104. .RS
  105. .TP
  106. .BI name " NAME " (default)
  107. select the tunnel device name.
  109. .TP
  110. .BI mode " MODE"
  111. set the tunnel mode. Available modes depend on the encapsulating address family.
  112. .br
  113. Modes for IPv4 encapsulation available:
  114. .BR ipip ", " sit ", " isatap ", " vti ", and " gre "."
  115. .br
  116. Modes for IPv6 encapsulation available:
  117. .BR ip6ip6 ", " ipip6 ", " ip6gre ", " vti6 ", and " any "."
  119. .TP
  120. .BI remote " ADDRESS"
  121. set the remote endpoint of the tunnel.
  123. .TP
  124. .BI local " ADDRESS"
  125. set the fixed local address for tunneled packets.
  126. It must be an address on another interface of this host.
  128. .TP
  129. .BI ttl " N"
  130. .TP
  131. .BI hoplimit " N"
  132. set a fixed TTL (IPv4) or hoplimit (IPv6)
  133. .I N
  134. on tunneled packets.
  135. .I N
  136. is a number in the range 1--255. 0 is a special value
  137. meaning that packets inherit the TTL value.
  138. The default value for IPv4 tunnels is:
  139. .BR "inherit" .
  140. The default value for IPv6 tunnels is:
  141. .BR "64" .
  144. .TP
  145. .BI tos " T"
  146. .TP
  147. .BI dsfield " T"
  148. .TP
  149. .BI tclass " T"
  150. set the type of service (IPv4) or traffic class (IPv6) field on
  151. tunneled packets, which can be specified as either a two-digit
  152. hex value (e.g. c0) or a predefined string (e.g. internet).
  153. The value
  154. .B inherit
  155. causes the field to be copied from the original IP header. The
  156. values
  157. .BI "inherit/" STRING
  158. or
  159. .BI "inherit/" 00 ".." ff
  160. will set the field to
  161. .I STRING
  162. or
  163. .IR 00 ".." ff
  164. when tunneling non-IP packets. The default value is 00.
  166. .TP
  167. .BI dev " NAME"
  168. bind the tunnel to the device
  169. .I NAME
  170. so that tunneled packets will only be routed via this device and will
  171. not be able to escape to another device when the route to endpoint
  172. changes.
  174. .TP
  175. .B nopmtudisc
  176. disable Path MTU Discovery on this tunnel.
  177. It is enabled by default. Note that a fixed ttl is incompatible
  178. with this option: tunneling with a fixed ttl always makes pmtu
  179. discovery.
  181. .TP
  182. .B ignore-df
  183. enable IPv4 DF suppression on this tunnel.
  184. Normally datagrams that exceed the MTU will be fragmented; the presence
  185. of the DF flag inhibits this, resulting instead in an ICMP Unreachable
  186. (Fragmentation Required) message.  Enabling this attribute causes the
  187. DF flag to be ignored.
  189. .TP
  190. .BI key " K"
  191. .TP
  192. .BI ikey " K"
  193. .TP
  194. .BI okey " K"
  195. .RB ( " only GRE tunnels " )
  196. use keyed GRE with key
  197. .IR K ". " K
  198. is either a number or an IP address-like dotted quad.
  199. The
  200. .B key
  201. parameter sets the key to use in both directions.
  202. The
  203. .BR ikey " and " okey
  204. parameters set different keys for input and output.
  206. .TP
  207. .BR csum ", " icsum ", " ocsum
  208. .RB ( " only GRE tunnels " )
  209. generate/require checksums for tunneled packets.
  210. The
  211. .B ocsum
  212. flag calculates checksums for outgoing packets.
  213. The
  214. .B icsum
  215. flag requires that all input packets have the correct
  216. checksum. The
  217. .B csum
  218. flag is equivalent to the combination
  219. .BR "icsum ocsum" .
  221. .TP
  222. .BR seq ", " iseq ", " oseq
  223. .RB ( " only GRE tunnels " )
  224. serialize packets.
  225. The
  226. .B oseq
  227. flag enables sequencing of outgoing packets.
  228. The
  229. .B iseq
  230. flag requires that all input packets are serialized.
  231. The
  232. .B  seq
  233. flag is equivalent to the combination
  234. .BR "iseq oseq" .
  235. .B It doesn't work. Don't use it.
  237. .TP
  238. .BI encaplimit " ELIM"
  239. .RB ( " only IPv6 tunnels " )
  240. set a fixed encapsulation limit. Default is 4.
  242. .TP
  243. .BI flowlabel " FLOWLABEL"
  244. .RB ( " only IPv6 tunnels " )
  245. set a fixed flowlabel.
  247. .TP
  248. .BI allow-localremote
  249. .RB ( " only IPv6 tunnels " )
  250. allow remote endpoint on the local host.
  251. .RE
  253. .TP
  254. .B ip tunnel prl
  255. potential router list (ISATAP only)
  256. .RS
  257. .TP
  258. .BI dev " NAME"
  259. mandatory device name.
  261. .TP
  262. .BI prl-default " ADDR"
  263. .TP
  264. .BI prl-nodefault " ADDR"
  265. .TP
  266. .BI prl-delete " ADDR"
  267. .RB "Add or delete " ADDR
  268. as a potential router or default router.
  269. .RE
  271. .TP
  272. .B ip tunnel show
  273. list tunnels
  274. This command has no arguments.
  276. .SH SEE ALSO
  277. .br
  278. .BR ip (8)
  280. .SH AUTHOR
  281. Original Manpage by Michail Litvak <mci@owl.openwall.com>