sppptun(1m) - osol9

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

NAME

6       sppptun - PPP tunneling driver utility
7

SYNOPSIS

9       sppptun plumb
10
11
12       sppptun plumb [-s sap] protocol device
13
14
15       sppptun unplumb interface
16
17
18       sppptun query
19
20

DESCRIPTION

22       The sppptun utility is used to configure and query the Solaris PPP tun‐
23       neling device driver, /dev/sppptun. Currently, only PPP  over  Ethernet
24       (PPPoE)  is  supported,  so the plumb and unplumb arguments are used to
25       specify Ethernet interfaces that are to be  used  for  PPPoE,  and  the
26       query option lists the plumbed interfaces.
27
28
29       The  use  of  sppptun to add interfaces is similar to the use of ifcon‐
30       fig(1M) to add interfaces to IP. The plumbing is  done  once  for  each
31       interface,  preferably  at  system  start-up  time, and is not normally
32       manipulated on a running system. If multiple instances of PPP  are  run
33       over  a  single  interface,  they share the plumbing to that interface.
34       Plumbing for each session is not required (and not possible for PPPoE).
35
36
37       The proper way to plumb interfaces for PPPoE is to list the interfaces,
38       one  per  line,  in  the /etc/ppp/pppoe.if file. If alternate Ethertype
39       (SAP) values are necessary, then include the PPPoE Session and  Discov‐
40       ery Stage values as hexadecimal on the same line. The line format is:
41
42         interface [session [discovery]]
43
44
45
46
47       The  defaults  are the Ethertypes specified in RFC 2516, and most users
48       should not need to set these values. See the examples for one  possible
49       use.
50

USAGE

52       sppptun plumb
53
54           When  specified  with  no  additional arguments, the plumb argument
55           lists the protocols that are supported by the  utility.  These  are
56           the strings that are used as the protocol argument below.
57
58
59       sppptun plumb [-s sap] protocol device
60
61           This plumbs a new interface into the driver. The protocol parameter
62           is pppoe for the PPP-carrying "Session Stage" connection or  pppoed
63           for  the  PPPoE "Discovery Stage" connection. Both connections must
64           be present for each Ethernet interface  that  is  to  be  used  for
65           PPPoE. The device parameter is the path name of the Ethernet inter‐
66           face to use (use ifconfig(1M) to list available  devices).  If  the
67           path begins with /dev/, then this portion may be omitted.
68
69           The  -s  sap  option can be specified to use an alternate Ethertype
70           (SAP) for the selected protocol. The sap value  must  be  given  in
71           hexadecimal. Some access servers use Ethertypes for PPPoE different
72           from those in RFC 2516. The defaults are 8864 for  pppoe  and  8863
73           for pppoed.
74
75
76       sppptun unplumb interface
77
78           This  removes  an existing interface from the driver and terminates
79           any PPP sessions that  were  using  the  interface.  The  interface
80           parameter  is the name of the interface as reported when the inter‐
81           face was plumbed.
82
83
84       sppptun query
85
86           Displays the canonical names of all  interfaces  plumbed  into  the
87           /dev/sppptun device driver.
88
89

EXAMPLES

91       Example 1 Setting up to Use PPPoE on hme0
92
93
94       Plumb the hme0 interface.
95
96
97         # sppptun plumb pppoed hme0
98         hme0:pppoed
99         # sppptun plumb pppoe hme0
100         hme0:pppoe
101
102
103
104
105       Remove the hme0 interface.
106
107
108         # sppptun unplumb hme0:pppoed
109         # sppptun unplumb hme0:pppoe
110
111
112
113       Example 2 Script to Remove All Plumbed Interfaces
114
115         #!/bin/sh
116         for intf in `sppptun query`
117         do
118                 sppptun unplumb $intf
119         done
120
121
122
123       Example 3 Interoperating with 3COM HomeConnect Dual Link ADSL
124
125         # dladm show-link
126         LINK        CLASS    MTU    STATE    OVER
127         nge0        phys     1500   up       --
128         # echo nge0 3c13 3c12 > /etc/ppp/pppoe.if
129
130
131

EXIT STATUS

133       The following exit values are returned:
134
135       0    Successful completion.
136
137
138       1    One or more errors occurred.
139
140

FILES

142       /etc/ppp/pppoe.if    list  of Ethernet interfaces to be plumbed at boot
143                            time
144
145
146       /usr/sbin/sppptun    executable command
147
148
149       /dev/sppptun         Solaris PPP tunneling device driver
150
151

ATTRIBUTES

153       See attributes(5) for descriptions of the following attributes:
154
155
156
157
158       ┌─────────────────────────────┬─────────────────────────────┐
159       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
160       ├─────────────────────────────┼─────────────────────────────┤
161       │Availability                 │SUNWpppdt                    │
162       └─────────────────────────────┴─────────────────────────────┘
163