]>
Commit | Line | Data |
---|---|---|
bd767a3e MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone-ip-tunnel"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-ip-tunnel</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-ip-tunnel</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-ip-tunnel</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network zone new <replaceable>ZONE</replaceable> ip-tunnel ...</command> | |
33 | </cmdsynopsis> | |
34 | ||
35 | <cmdsynopsis> | |
36 | <command>network zone <replaceable>ZONE</replaceable> edit ...</command> | |
37 | </cmdsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | The ip-tunnel hook is used to create IP tunnels that use protocols | |
45 | like GRE to encapsulate IP packets. | |
46 | </para> | |
47 | </refsect1> | |
48 | ||
49 | <refsect1> | |
50 | <title>Options</title> | |
51 | ||
52 | <para> | |
53 | The following options are understood: | |
54 | </para> | |
55 | ||
56 | <variablelist> | |
57 | <varlistentry> | |
58 | <term> | |
59 | <option>--mode=<replaceable>MODE</replaceable></option> | |
60 | </term> | |
61 | ||
62 | <listitem> | |
63 | <para> | |
64 | Sets the protocol that is being used to encapsulate | |
65 | IP packets. | |
66 | Currently only <replaceable>gre</replaceable> is supported. | |
67 | </para> | |
68 | </listitem> | |
69 | </varlistentry> | |
70 | ||
71 | <varlistentry> | |
72 | <term> | |
73 | <option>--peer=<replaceable>PEER</replaceable></option> | |
74 | </term> | |
75 | ||
76 | <listitem> | |
77 | <para> | |
78 | The address of the peer that terminates the remote | |
79 | end of this tunnel. | |
80 | </para> | |
bfaa4f61 MT |
81 | |
82 | <para> | |
83 | If left empty, connections from any IP address will | |
84 | be accepted. | |
85 | </para> | |
bd767a3e MT |
86 | </listitem> |
87 | </varlistentry> | |
88 | ||
89 | <varlistentry> | |
90 | <term> | |
91 | <option>--local-address=<replaceable>LOCAL-ADDRESS</replaceable></option> | |
92 | </term> | |
93 | ||
94 | <listitem> | |
95 | <para> | |
96 | The local IP address the tunnel originates from. | |
97 | </para> | |
98 | ||
99 | <para> | |
100 | This is optional and if unset a useful default will be used. | |
101 | </para> | |
102 | </listitem> | |
103 | </varlistentry> | |
104 | </variablelist> | |
105 | </refsect1> | |
106 | ||
107 | <refsect1> | |
108 | <title>See Also</title> | |
109 | ||
110 | <para> | |
111 | <citerefentry> | |
112 | <refentrytitle>network</refentrytitle> | |
113 | <manvolnum>8</manvolnum> | |
114 | </citerefentry>, | |
115 | <citerefentry> | |
116 | <refentrytitle>network-zone</refentrytitle> | |
117 | <manvolnum>8</manvolnum> | |
118 | </citerefentry> | |
119 | </para> | |
120 | </refsect1> | |
121 | </refentry> |