Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pppoed(8) [freebsd man page]

PPPOED(8)						    BSD System Manager's Manual 						 PPPOED(8)

NAME
pppoed -- handle incoming PPP over Ethernet connections SYNOPSIS
pppoed [-Fd] [-P pidfile] [-a name] [-e exec | -l label] [-n ngdebug] [-p provider] interface DESCRIPTION
The pppoed utility listens to the given interface for PPP over Ethernet (PPPoE) service request packets, and actions them by negotiating a session then invoking a ppp(8) program. The negotiation is implemented by the ``pppoe'' netgraph node. See ng_pppoe(4) for details. The pppoed utility will only offer services to clients requesting services from the given provider, which is taken as an empty name if not provided. If a provider name of ``*'' is given, any PPPoE requests will be offered service. The supplied name will be given as the access concentrator name when establishing the connection. If no name is given, the current base hostname is used. After receiving a request (PADI) from the PPPoE netgraph node, pppoed fork(2)s a child process and returns to service further requests. The child process offers service (using name) and waits for a SUCCESS indication from the PPPoE node. On receipt of the SUCCESS indication, pppoed will execute exec /usr/sbin/ppp -direct label as a shell sub-process. If label has not been specified, it defaults to provider. It is possible to specify another command using the exec argument. This is mandatory if provider and label are not given. The child process will have standard input and standard output attached to the same netgraph(4) data socket (see ng_socket(4)) when started. The environment variables HISMACADDR and ACNAME are made available to the child process and are set to the MAC address of the peer and the name of the AC respectively. Upon invocation, pppoed will attach a ``pppoe'' netgraph node to the relevant ``ether'' node using ``interface:'' as the node name, and then connect that ``pppoe'' node to a local ``socket'' node. If the -F option has not been given, pppoed will then go into the background and disassociate itself from the controlling terminal. When the -F option is given, pppoed stays in the foreground. If the -d option is given, additional diagnostics are provided (see the DIAGNOSTICS section below). If the -n option is given, NgSetDebug() is called with an argument of ngdebug. If pidfile is given, pppoed will write its process ID to this file on startup. DIAGNOSTICS
After creating the necessary netgraph(4) nodes as described above, pppoed uses syslogd(8) to report all incoming connections. If the -d option is given, pppoed will report on the child processes creation of a new netgraph socket, its service offer and the invocation of the ppp(8) program. If the -n option is given, netgraph diagnostic messages are also redirected to syslogd(8). It is sometimes useful to add the following to /etc/syslog.conf: !pppoed *.* /var/log/pppoed.log and the following to /etc/newsyslog.conf: /var/log/pppoed.log 640 3 100 * Z SEE ALSO
NgSetDebug(3), netgraph(4), ng_ether(4), ng_pppoe(4), ng_socket(4), syslog.conf(5), ppp(8), syslogd(8) HISTORY
The pppoed utility was written by Brian Somers <brian@Awfulhak.org> and first appeared in FreeBSD 3.4. BUGS
If another netgraph node is using the given interface, pppoed will fail to start. This is because netgraph(4) does not currently allow node chaining. This may change in the future. BSD
November 8, 1999 BSD

Check Out this Related Man Page

sppptun(1M)						  System Administration Commands					       sppptun(1M)

NAME
sppptun - PPP tunneling driver utility SYNOPSIS
sppptun plumb sppptun plumb protocol device sppptun unplumb interface sppptun query DESCRIPTION
The sppptun utility is used to configure and query the Solaris PPP tunneling device driver, /dev/sppptun. Currently, only PPP over Ether- net (PPPoE) is supported, so the plumb and unplumb arguments are used to specify Ethernet interfaces that are to be used for PPPoE, and the query option lists the plumbed interfaces. The use of sppptun to add interfaces is similar to the use of ifconfig(1M) to add interfaces to IP. The plumbing is done once for each interface, preferably at system start-up time, and is not normally manipulated on a running system. If multiple instances of PPP are run over a single interface, they share the plumbing to that interface. Plumbing for each session is not required (and not possible for PPPoE). The proper way to plumb interfaces for PPPoE is to list the interfaces, one per line, in the /etc/ppp/pppoe.if file. USAGE
sppptun plumb When specified with no additional arguments, the plumb argument lists the protocols that are supported by the utility. These are the strings that are used as the protocol argument below. sppptun plumb protocol device This plumbs a new interface into the driver. The protocol parameter is pppoe for the PPP-carrying "Session Stage" connection or pppoed for the PPPoE "Discovery Stage" connection. Both connections must be present for each Ethernet interface that is to be used for PPPoE. The device parameter is the path name of the Ethernet interface to use (use ifconfig(1M) to list available devices). If the path begins with /dev/, then this portion may be omitted. sppptun unplumb interface This removes an existing interface from the driver and terminates any PPP sessions that were using the interface. The interface parame- ter is the name of the interface as reported when the interface was plumbed. sppptun query Displays the canonical names of all interfaces plumbed into the /dev/sppptun device driver. EXAMPLES
Example 1: Setting up to Use PPPoE on hme0 Plumb the hme0 interface. # sppptun plumb pppoed hme0 hme0:pppoed # sppptun plumb pppoe hme0 hme0:pppoe Remove the hme0 interface. # sppptun unplumb hme0:pppoed # sppptun unplumb hme0:pppoe Example 2: Script to Remove All Plumbed Interfaces #!/bin/sh for intf in `sppptun query` do sppptun unplumb $intf done EXIT STATUS
The following exit values are returned: 0 Successful completion. 1 One or more errors occurred. FILES
/etc/ppp/pppoe.if list of Ethernet interfaces to be plumbed at boot time /usr/sbin/sppptun executable command /dev/sppptun Solaris PPP tunneling device driver ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWpppdt | +-----------------------------+-----------------------------+ SEE ALSO
pppd(1M), pppoec(1M), pppoed(1M), sppptun(7M) RFC 2516, Method for Transmitting PPP Over Ethernet (PPPoE), Mamakos et al, February 1999 SunOS 5.10 19 Mar 2001 sppptun(1M)
Man Page