1PPPOE-SERVER(8) System Manager's Manual PPPOE-SERVER(8)
2
6 pppoe-server - user-space PPPoE server
7
9 pppoe-server [options]
10
13 pppoe-server is a user-space server for PPPoE (Point-to-Point Protocol
14 over Ethernet) for Linux and other UNIX systems. pppoe-server works in
15 concert with the pppoe client to respond to PPPoE discovery packets and
16 set up PPPoE sessions.
17
20 -F The -F option causes pppoe-server not to fork and become a dae‐
21 mon. The default is to fork and become a daemon.
22 -I interface
25 The -I option specifies the Ethernet interface to use. Under
26 Linux, it is typically eth0 or eth1. The interface should be
27 "up" before you start pppoe-server, but should not be configured
28 to have an IP address. You can supply multiple -I options if
29 you want the server to respond on more than one interface.
30 -T timeout
33 This option is passed directly to pppoe; see pppoe(8) for
34 details. If you are using kernel-mode PPPoE, this option has no
35 effect.
36 -C ac_name
39 Specifies which name to report as the access concentrator name.
40 If not supplied, the host name is used.
41 -S name
44 Offer a service named name. Multiple -S options may be speci‐
45 fied; each one causes the named service to be advertised in a
46 Service-Name tag in the PADO frame. The first -S option speci‐
47 fies the default service, and is used if the PPPoE client
48 requests a Service-Name of length zero.
49 -m MSS This option is passed directly to pppoe; see pppoe(8) for
52 details. If you are using kernel-mode PPPoE, this option has no
53 effect.
54 -x n Limit the number of sessions per peer MAC address to n. If a
57 given MAC address attempts to create more than n sessions, then
58 its PADI and PADR packets are ignored. If you set n to 0 (the
59 default), then no limit is imposed on the number of sessions per
60 peer MAC address.
61 -s This option is passed directly to pppoe; see pppoe(8) for
64 details. In addition, it causes pppd to be invoked with the
65 sync option.
66 -L ip Sets the local IP address. This is passed to spawned pppd pro‐
69 cesses. If not specified, the default is 10.0.0.1.
70 -R ip Sets the starting remote IP address. As sessions are estab‐
73 lished, IP addresses are assigned starting from ip. pppoe-
74 server automatically keeps track of the pool of addresses and
75 passes a valid remote IP address to pppd. If not specified, a
76 starting address of 10.67.15.1 is used.
77 -N num Allows at most num concurrent PPPoE sessions. If not specified,
80 the default is 64.
81 -O fname
84 This option causes pppoe-server to tell pppd to use the option
85 file fname instead of the default /etc/ppp/pppoe-server-options.
86 -p fname
89 Reads the specified file fname which is a text file consisting
90 of one IP address per line. These IP addresses will be assigned
91 to clients. The number of sessions allowed will equal the num‐
92 ber of addresses found in the file. The -p option overrides
93 both -R and -N.
94 In addition to containing IP addresses, the pool file can con‐
96 tain lines of the form:
97 a.b.c.d-e
99 which includes all IP addresses from a.b.c.d to a.b.c.e. For
101 example, the line:
102 1.2.3.4-7
104 is equivalent to:
106 1.2.3.4
108 1.2.3.5
109 1.2.3.6
110 1.2.3.7
111 -r Tells the PPPoE server to randomly permute session numbers.
114 Instead of handing out sessions in order, the session numbers
115 are assigned in an unpredictable order.
116 -u Tells the server to invoke pppd with the unit option. Note that
119 this option only works for pppd version 2.4.0 or newer.
120 -o offset
123 Instead of numbering PPPoE sessions starting at 1, they will be
124 numbered starting at offset+1. This allows you to run multiple
125 servers on a given machine; just make sure that their session
126 numbers do not overlap.
127 -f disc:sess
130 The -f option sets the Ethernet frame types for PPPoE discovery
131 and session frames. The types are specified as hexadecimal num‐
132 bers separated by a colon. Standard PPPoE uses frame types
133 8863:8864. You should not use this option unless you are abso‐
134 lutely sure the peer you are dealing with uses non-standard
135 frame types.
136 -k The -k option tells the server to use kernel-mode PPPoE on
139 Linux. This option is available only on Linux kernels 2.4.0 and
140 later, and only if the server was built with kernel-mode sup‐
141 port.
142 -h The -h option prints a brief usage message and exits.
145
148 pppoe-server listens for incoming PPPoE discovery packets. When a ses‐
149 sion is established, it spawns a pppd process. The following options
150 are passed to pppd:
151 nodetach noaccomp nobsdcom nodeflate nopcomp novj novjccomp
153 default-asyncmap
154 In addition, the local and remote IP address are set based on the -L
156 and -R options. The pty option is supplied along with a pppoe command
157 to initiate the PPPoE session. Finally, additional pppd options can be
158 placed in the file /etc/ppp/pppoe-server-options (which must exist,
159 even if it is just empty!)
160 Note that pppoe-server is meant mainly for testing PPPoE clients. It
162 is not a high-performance server meant for production use.
163
166 pppoe-server was written by David F. Skoll <dfs@roaringpenguin.com>.
167 The pppoe home page is http://www.roaringpenguin.com/pppoe/.
169
172 pppoe-start(8), pppoe-stop(8), pppoe-connect(8), pppd(8),
173 pppoe.conf(5), pppoe(8), pppoe-setup(8), pppoe-status(8), pppoe-
174 sniff(8), pppoe-relay(8)
1754th Berkeley Distribution 21 June 2008 PPPOE-SERVER(8)