1pppoec(1M)              System Administration Commands              pppoec(1M)
2
3
4

NAME

6       pppoec - PPPoE chat utility
7

SYNOPSIS

9       pppoec [-omillisecs] [-smillisecs] [-v] device
10            [service [ [except]server... [only]]]
11
12
13       pppoec [-omillisecs] [-v] -i [device]
14
15

DESCRIPTION

17       The  pppoec utility implements the client-side negotiation of PPPoE. It
18       is intended to be used with the pppd(1M) connect option,  in  the  same
19       manner as the chat(1M) utility is used for asynchronous dial-up PPP.
20
21
22       When  given with the -i flag, pppoec sends out a broadcast query on the
23       given interface named by the device parameter. You can specify no other
24       arguments  in  this  mode. All responding PPPoE servers and the offered
25       services are displayed on standard output.
26
27
28       Otherwise, when given without the -i flag, pppoec does the  full  PPPoE
29       client-side  negotiation. The device parameter is the intended Ethernet
30       interface, and must already be plumbed with sppptun(1M).  The  optional
31       service parameter specifies a particular service desired; other offered
32       services will be ignored. The optional  server  parameter  specifies  a
33       specific  server desired. You can specify server as an Ethernet address
34       in the usual x:x:x:x:x:x format (with "*" in any of the six byte  posi‐
35       tions  interpreted  to  mean  "any"),  or  as  a symbolic name resolved
36       through /etc/ethers (or NIS), or as a PPPoE access  concentrator  name.
37       The  sense  of  the match (true or false) can be inverted by specifying
38       the keyword except before this string. This parameter can be  specified
39       more than once, and the first match is taken.
40
41
42       If  you  specify the server parameter, then the selected servers become
43       "preferred." If no preferred server responds, then the first responding
44       server  is  used  instead.  To  exclude  non-matching servers entirely,
45       append the keyword only.
46

OPTIONS

48       The following options are supported:
49
50       -i    Sends out broadcast query over interface specified by device.
51
52
53       -o    Sets the initial wait time in  milliseconds  for  PADO  from  the
54             server  before  PADI  is retried. The default is 500 milliseconds
55             for normal  operation,  or  3000  milliseconds  (3  seconds)  for
56             inquiry (-i) mode.
57
58
59       -s    Sets  the  initial  wait  time  in milliseconds for PADS from the
60             server before PADR is retried. The default is  2000  milliseconds
61             (2 seconds).
62
63
64       -v    Displays  verbose progress messages, including all PPPoE messages
65             sent, and all state machine transitions.
66
67
68
69       You normally do not need to adjust the parameters set with -o  and  -s.
70       They are provided for coping with unusually slow servers.
71

OPERANDS

73       The following operands are supported:
74
75       device     plumbed Ethernet interface
76
77
78       server     preferred  server  or,  if  you  specify only, the specified
79                  server
80
81
82       service    desired service; other available services are ignored
83
84

EXAMPLES

86       Example 1 Connecting to Any Service on hme0
87
88
89       The following command enables you to connect to any  PPPoE  service  on
90       hme0:
91
92
93         # /usr/bin/pppd sppptun plugin pppoe.so connect "/usr/lib/inet/pppoec hme0" debug
94
95
96
97
98       Often,   a   command   such   as  the  preceding  is  specified  in  an
99       /etc/ppp/peers file  instead.  For  example,  enter  the  following  in
100       /etc/ppp/peers/myisp:
101
102
103         sppptun
104         plugin pppoe.so
105         connect "/usr/lib/inet/pppoec hme0"
106         debug
107
108
109
110
111       To invoke the PPP connection described in the file, enter:
112
113
114         % /usr/bin/pppd call myisp
115
116
117
118
119       Note  that,  because the /etc/ppp/peers files are considered privileged
120       by pppd, you need not be root to invoke the preceding command.
121
122
123       Example 2 Connecting to a Particular Service
124
125
126       A more complex example: on hme0, connect to only the  internet  service
127       offered  by PPPoE servers with access concentrator name isp, but not to
128       any Ethernet addresses starting with 40:0:1a.
129
130
131         # /usr/lib/inet/pppoec hme0 internet except 40:0:1a:*:*:* isp only
132
133
134
135
136       Note that the except 40:0:1a:*:*:* filter must come before isp, because
137       the filters are first-match.
138
139

EXIT STATUS

141       The following exit values are returned:
142
143       0     Successful completion.
144
145
146       >0    An error occurred.
147
148

FILES

150       /usr/lib/inet/pppoec       executable command
151
152
153       /dev/sppptun               Solaris PPP tunneling device driver.
154
155
156       /etc/ppp/connect-errors    usual location of error output (see DIAGNOS‐
157                                  TICS, below)
158
159

ATTRIBUTES

161       See attributes(5) for descriptions of the following attributes:
162
163
164
165
166       ┌─────────────────────────────┬─────────────────────────────┐
167       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
168       ├─────────────────────────────┼─────────────────────────────┤
169       │Availability                 │SUNWpppdt                    │
170       └─────────────────────────────┴─────────────────────────────┘
171

SEE ALSO

173       pppd(1M), sppptun(1M), pppoed(1M), sppptun(7M)
174
175
176       RFC 2516, Method for Transmitting PPP Over Ethernet (PPPoE), Mamakos et
177       al, February 1999
178

DIAGNOSTICS

180       Error  messages  are written to standard error, which is normally redi‐
181       rected by pppd to /etc/ppp/connect-errors. The errors can also be redi‐
182       rected to pppd's standard output by using the updetach option.
183
184
185       If you specify the -v, verbose progress messages are displayed, includ‐
186       ing all PPPoE messages sent, and all state machine transitions.  Speci‐
187       fying  the  updetach or nodetach pppd option is helpful when using ver‐
188       bose mode.
189
190
191
192SunOS 5.11                        9 Jan 2002                        pppoec(1M)
Impressum