]>
Commit | Line | Data |
---|---|---|
b5cacc07 SS |
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-pptp"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-pptp</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Stefan</firstname> | |
14 | <surname>Schantl</surname> | |
15 | <email>stefan.schantl@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-pptp</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-pptp</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network zone create <replaceable>ZONE</replaceable> pptp ...</command> | |
33 | </cmdsynopsis> | |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para> | |
40 | The pptp hook creates a Point-to-Point tunnel over IP and is used by some ISP for | |
41 | internet dialin or other VPN services. | |
42 | </para> | |
43 | </refsect1> | |
44 | ||
45 | <refsect1> | |
46 | <title>Options</title> | |
47 | ||
48 | <para> | |
49 | The following options are understood: | |
50 | </para> | |
51 | ||
52 | <variablelist> | |
53 | <varlistentry> | |
54 | <term> | |
55 | <option>--peer-address=<replaceable>ADDRESS</replaceable></option> | |
56 | </term> | |
57 | ||
58 | <listitem> | |
59 | <para> | |
60 | The IPv4 address of the system to connect to. | |
61 | </para> | |
62 | <para> | |
63 | For PPTP dialin connections this will be IP address of your modem. | |
64 | If you are using PPTP for VPN services use the address of the remote server. | |
65 | </para> | |
66 | </listitem> | |
67 | </varlistentry> | |
68 | ||
69 | <varlistentry> | |
70 | <term> | |
71 | <option>--username=<replaceable>USERNAME</replaceable></option> | |
72 | </term> | |
73 | ||
74 | <listitem> | |
75 | <para> | |
76 | Sets the username for authentication. | |
77 | </para> | |
78 | </listitem> | |
79 | </varlistentry> | |
80 | ||
81 | <varlistentry> | |
82 | <term> | |
83 | <option>--password=<replaceable>PASSWORD</replaceable></option> | |
84 | </term> | |
85 | ||
86 | <listitem> | |
87 | <para> | |
88 | Sets the password for authentication. | |
89 | </para> | |
90 | <para> | |
91 | Use the <option>--auth=</option> option to transmit it | |
92 | in a secure manner to the provider. | |
93 | </para> | |
94 | </listitem> | |
95 | </varlistentry> | |
96 | ||
97 | <varlistentry> | |
98 | <term> | |
99 | <option>--port=<replaceable>PORT</replaceable></option> | |
100 | </term> | |
101 | ||
102 | <listitem> | |
103 | <para> | |
104 | This options sets the port, pppd is using to connect to | |
105 | the modem. This may be a normal ethernet or vlan interface. | |
106 | </para> | |
107 | <para> | |
108 | The port option is only required if you are using PPTP for | |
109 | dialin connections. | |
110 | </para> | |
111 | </listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term> | |
116 | <option>--interface-address=<replaceable>ADDRESS</replaceable></option> | |
117 | </term> | |
118 | ||
119 | <listitem> | |
120 | <para> | |
121 | Add this IPV4 address to the configured port. | |
122 | </para> | |
123 | ||
124 | <para> | |
125 | Optionally a DHCP client can be used, istead of | |
126 | configuring a static IPv4 address. Use the <option>--use-dhcp</option> | |
127 | to benefit from this feature. | |
128 | </para> | |
129 | </listitem> | |
130 | </varlistentry> | |
131 | ||
132 | <varlistentry> | |
133 | <term> | |
134 | <option>--prefix=<replaceable>PREFIX</replaceable></option> | |
135 | </term> | |
136 | ||
137 | <listitem> | |
138 | <para> | |
139 | Sets the following network prefix to the configured port. | |
140 | </para> | |
141 | </listitem> | |
142 | </varlistentry> | |
143 | ||
144 | <varlistentry> | |
145 | <term> | |
146 | <option>--use-dhcp=[<emphasis>false</emphasis>|true]</option> | |
147 | </term> | |
148 | ||
149 | <listitem> | |
150 | <para> | |
151 | Use a DHCP client to gather the interface address and prefix settings. | |
152 | </para> | |
153 | </listitem> | |
154 | </varlistentry> | |
155 | ||
156 | <varlistentry> | |
157 | <term> | |
158 | <option>--ipv6=[<emphasis>true</emphasis>|false]</option> | |
159 | </term> | |
160 | ||
161 | <listitem> | |
162 | <para> | |
163 | By this option the support for IPv6 can be enabled or disabled. | |
164 | </para> | |
165 | </listitem> | |
166 | </varlistentry> | |
167 | ||
168 | <varlistentry> | |
169 | <term> | |
170 | <option>--mtu=<emphasis>1492</emphasis></option> | |
171 | </term> | |
172 | ||
173 | <listitem> | |
174 | <para> | |
175 | Sets the default MTU of the PPP connection. | |
176 | The default value is 1492 which is a common MTU used | |
177 | for DSL. | |
178 | </para> | |
179 | </listitem> | |
180 | </varlistentry> | |
181 | ||
182 | <varlistentry> | |
183 | <term> | |
184 | <option>--auth=[chap|pap]</option> | |
185 | </term> | |
186 | ||
187 | <listitem> | |
188 | <para> | |
189 | Define the authentication method that is used to | |
190 | authenticate against your provider. | |
191 | The default is to use the provider's preference. | |
192 | </para> | |
193 | <itemizedlist> | |
194 | <listitem> | |
195 | <para> | |
196 | <emphasis>Challange-Handshake Authentication Protocol</emphasis> | |
197 | (chap) is the preferred secure method. | |
198 | </para> | |
199 | </listitem> | |
200 | <listitem> | |
201 | <para> | |
202 | <emphasis>Password Authentication Protocol</emphasis> | |
203 | (pap) sends the plaintext password to the authentication | |
204 | server which is the reason why it should be avoided to use PAP. | |
205 | </para> | |
206 | </listitem> | |
207 | </itemizedlist> | |
208 | </listitem> | |
209 | </varlistentry> | |
210 | ||
211 | <varlistentry> | |
212 | <term> | |
213 | <option>--refuse-auth-methods=<replaceable>STRING</replaceable></option> | |
214 | </term> | |
215 | ||
216 | <listitem> | |
217 | <para> | |
218 | By this option, you may define a list of auth methods which | |
219 | are not supported by the service provider. | |
220 | </para> | |
221 | </listitem> | |
222 | </varlistentry> | |
223 | </variablelist> | |
224 | </refsect1> | |
225 | ||
226 | <refsect1> | |
227 | <title>See Also</title> | |
228 | ||
229 | <para> | |
230 | <citerefentry> | |
231 | <refentrytitle>network</refentrytitle> | |
232 | <manvolnum>8</manvolnum> | |
233 | </citerefentry>, | |
234 | <citerefentry> | |
235 | <refentrytitle>network-zone</refentrytitle> | |
236 | <manvolnum>8</manvolnum> | |
237 | </citerefentry> | |
238 | </para> | |
239 | </refsect1> | |
240 | </refentry> |