pppoed

Point-to-Point Protocol Over Ethernet (PPPOE) daemon

Syntax:

pppoed [options] [suboptions]

Runs on:

Neutrino

Options:

The options are:

-F file

Read the arguments from the given file.

-q

Be quiet.

-v[v]...

Verbose output; more v characters cause more verbosity. In order to capture the log messages, you need to have syslogd running.

The suboptions are:

device=name

Specify the PPPoE device. The default is /dev/io-net/ppp_en.

en=name

Specify the Ethernet device by name ("" means all).

local_mac=mac

Specify the Ethernet device by MAC (ffffffffffff means all).

logfd= fd

Log debug information to the given file descriptor; the default is no FD). If logging to 0, 1, or 2, you must specify the nodetach option.

name=name

Specify the AC_NAME tag ("" means any).

nodetach

Don't move into the background.

noscript

Don't execute the up or down script.

persist

Continue forever to retry connecting (by default, don't persist).

remote_mac=mac

Specify the server Ethernet MAC (ffffffffffff means any).

retries=num

Specify the number of retries (the default is 10).

scriptdetach

Don't exit when the upscript terminates.

service=name

The SERVICE_NAME tag to use ("" means any).

timeout=t

The initial timeout, in seconds (the default is 1).

verbose=v

The verbosity level; the default is 1, and the maximum is 10. In order to capture the log messages, you need to have syslogd running.

Description:

Use the pppoed daemon to negotiate the PPPOE session. Once the PPPOE session is established, pppd is used to create a point-to-point connection over the PPPOE session. The pppd daemon gets a local TCP/IP configuration from the server (ISP).

---

This utility needs to have the setuid ("set user ID") bit set in its permissions. If you use mkefs, mketfs, or mkifs on a Windows host to include this utility in an image, use the perms attribute to specify its permissions explicitly, and the uid and gid attributes to set the ownership correctly. If you find pppoed has problems connecting to certain sites on the Internet, take a look at the technote PPPOE and Path MTU Discovery.

---

The pppoed daemon uses the /etc/ppp/pppoe-up script to start pppd. The pppoe-up script contains the following commands:

#!/bin/sh
pppd debug /dev/io-net/ppp_en -ac -pc -detach defaultroute \
require-ns mtu 1492 name username

The options are (see pppd for full descriptions):

-ac -pc -detach

Required options that disable any packet compression.

defaultroute

Use the PPP connection peer address (server) as the gateway (default route).

require-ns

Get the nameserver addresses from the peer.

mtu 1492

Set the MTU to the supported value under PPPOE.

name username

The username of your ISP account (see "Authentication" in the documentation for pppd).

Note that the gateway and nameservers are obtained from the ISP, if possible; you don't need to be set them under phlip unless the nameservers aren't provided automatically.

Normally pppoed closes the PPPOE session and terminates when the upscript exits (i.e. when pppd terminates). If you don't want this to happen, use the scriptdetach option, which detaches pppoed from the execution of the script and makes pppoed wait for the session to close before terminating.

Normally, verbose debug messages are directed to the system log. If you want to have these messages also logged to a file descriptor, (e.g. in the case of spawning pppoed), specify the logfd option. All debug messages are then passed to the specified file descriptor.

When pppoed executes, it moves to the background when a session is established with an exit status of 0. If you specify the nodetach option, pppoed stays in the foreground.

Examples:

Start io-net with PPPOE support:

io-net -del900 -pttcpip -ppppmgr -ppppoe

Make a session to any server; this depends on /etc/ppp/pppoe-up to start pppd:

pppoed 

Make a session using en0 -- don't use other en* devices:

pppoed en=en0

Make a session to the server with name of PPPOE_GATWAY:

pppoed name=PPPOE_GATEWAY

Files:

/dev/io-net/ppp_en

The default PPPOE device.

/etc/ppp/pppoe-down

The default downscript.

/etc/ppp/pppoe-up

The default upscript.

See also:

io-net, pppd

"Network protocol modules (npm-*)" in the Utilities Summary

TCP/IP Networking in the Neutrino User's Guide

If you find pppoed has problems connecting to certain sites on the Internet, take a look at the technote PPPOE and Path MTU Discovery.