]>
Commit | Line | Data |
---|---|---|
a2a6f759 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-config-pppoe-server"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-config-pppoe-server</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-config-pppoe-server</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-config-pppoe-server</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network zone <replaceable>ZONE</replaceable> config create pppoe-server ...</command> | |
33 | </cmdsynopsis> | |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para> | |
40 | This configuration hook enables a <emphasis>PPPoE server</emphasis> | |
41 | functionality to a zone which is of an ethernet-like type. | |
42 | </para> | |
43 | <para> | |
44 | The PPPoE server is mostly for development purpose and performs pretty | |
45 | well. However, it is not recommended to use it in production environments. | |
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>--subnet=<replaceable>SUBNET</replaceable></option> | |
60 | </term> | |
61 | ||
62 | <listitem> | |
63 | <para> | |
64 | The <option>--subnet</option> option defines an IPv4 pool | |
65 | of which IP addresses are assigned to the remote hosts. | |
66 | The first address of the subnet will be used for the | |
67 | gateway which is the PPPoE server itself. | |
68 | </para> | |
69 | <para> | |
70 | The subnet must at least have two IP addresses. | |
71 | Broadcast and network addresses will be used as well. | |
72 | </para> | |
73 | </listitem> | |
74 | </varlistentry> | |
75 | ||
76 | <varlistentry> | |
77 | <term> | |
78 | <option>--mtu=<replaceable>MTU</replaceable></option> | |
79 | </term> | |
80 | ||
81 | <listitem> | |
82 | <para> | |
83 | Set the required MTU (Maximum Transmission Unit) for | |
84 | the PPP connection. | |
85 | </para> | |
86 | <para> | |
87 | The default value is 1492 bytes which is a common MTU for | |
88 | DSL connections. | |
89 | </para> | |
90 | </listitem> | |
91 | </varlistentry> | |
92 | ||
93 | <varlistentry> | |
94 | <term> | |
95 | <option>--service-name=<replaceable>STRING</replaceable></option> | |
96 | </term> | |
97 | ||
98 | <listitem> | |
99 | <para> | |
100 | This options receives a string which will be used as the | |
101 | service name. The service name is sent out to the clients | |
102 | and used for identification but not authorization purposes. | |
103 | </para> | |
104 | <para> | |
105 | The default is an empty value. | |
106 | </para> | |
107 | </listitem> | |
108 | </varlistentry> | |
109 | ||
110 | <varlistentry> | |
111 | <term> | |
112 | <option>--max-sessions=<emphasis>0</emphasis></option> | |
113 | </term> | |
114 | ||
115 | <listitem> | |
116 | <para> | |
117 | Limit the max. number of sessions that may be established | |
118 | by the same MAC address. | |
119 | </para> | |
120 | <para> | |
121 | This must be a positive number. 0 permits an unlimited | |
122 | number of sessions per MAC address. | |
123 | </para> | |
124 | </listitem> | |
125 | </varlistentry> | |
126 | </variablelist> | |
127 | </refsect1> | |
128 | ||
129 | <refsect1> | |
130 | <title>See Also</title> | |
131 | ||
132 | <para> | |
133 | <citerefentry> | |
134 | <refentrytitle>network</refentrytitle> | |
135 | <manvolnum>8</manvolnum> | |
136 | </citerefentry>, | |
137 | <citerefentry> | |
138 | <refentrytitle>network-zone-config</refentrytitle> | |
139 | <manvolnum>8</manvolnum> | |
140 | </citerefentry> | |
141 | </para> | |
142 | </refsect1> | |
143 | </refentry> |