usr/src/man/man1m/sppptun.1m

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SPPPTUN 1M "May 27, 2009"
   7 .SH NAME
   8 sppptun \- PPP tunneling driver utility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBsppptun plumb\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBsppptun plumb\fR [\fB-s\fR \fIsap\fR] \fIprotocol device\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBsppptun unplumb\fR \fIinterface\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBsppptun query\fR
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBsppptun\fR utility is used to configure and query the Solaris PPP
  34 tunneling device driver, \fB/dev/sppptun\fR. Currently, only PPP over Ethernet
  35 (PPPoE) is supported, so the \fBplumb\fR and \fBunplumb\fR arguments are used
  36 to specify Ethernet interfaces that are to be used for PPPoE, and the
  37 \fBquery\fR option lists the plumbed interfaces.
  38 .sp
  39 .LP
  40 The use of \fBsppptun\fR to add interfaces is similar to the use of
  41 \fBifconfig\fR(1M) to add interfaces to IP. The plumbing is done once for each
  42 interface, preferably at system start-up time, and is not normally manipulated
  43 on a running system. If multiple instances of PPP are run over a single
  44 interface, they share the plumbing to that interface. Plumbing for each session
  45 is not required (and not possible for PPPoE).
  46 .sp
  47 .LP
  48 The proper way to plumb interfaces for PPPoE is to list the interfaces, one per
  49 line, in the \fB/etc/ppp/pppoe.if\fR file. If alternate Ethertype (SAP) values
  50 are necessary, then include the PPPoE Session and Discovery Stage values as
  51 hexadecimal on the same line. The line format is:
  52 .sp
  53 .in +2
  54 .nf
  55 \fIinterface\fR [\fIsession\fR [\fIdiscovery\fR]]
  56 .fi
  57 .in -2
  58 .sp
  59
  60 .sp
  61 .LP
  62 The defaults are the Ethertypes specified in RFC 2516, and most users should
  63 not need to set these values. See the examples for one possible use.
  64 .SH USAGE
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBsppptun plumb\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 When specified with no additional arguments, the plumb argument lists the
  73 protocols that are supported by the utility. These are the strings that are
  74 used as the \fIprotocol\fR argument below.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBsppptun plumb [\fB-s\fR \fIsap\fR] \fIprotocol\fR \fIdevice\fR\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 This plumbs a new interface into the driver. The \fIprotocol\fR parameter is
  85 \fBpppoe\fR for the PPP-carrying "Session Stage" connection or \fBpppoed\fR for
  86 the PPPoE "Discovery Stage" connection. Both connections must be present for
  87 each Ethernet interface that is to be used for PPPoE. The \fIdevice\fR
  88 parameter is the path name of the Ethernet interface to use (use
  89 \fBifconfig\fR(1M) to list available devices). If the path begins with
  90 \fB/dev/\fR, then this portion may be omitted.
  91 .sp
  92 The \fB-s\fR \fIsap\fR option can be specified to use an alternate Ethertype
  93 (SAP) for the selected protocol. The \fIsap\fR value must be given in
  94 hexadecimal. Some access servers use Ethertypes for PPPoE different from those
  95 in RFC 2516. The defaults are 8864 for \fBpppoe\fR and 8863 for \fBpppoed\fR.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBsppptun unplumb \fIinterface\fR\fR\fR
 102 .ad
 103 .sp .6
 104 .RS 4n
 105 This removes an existing interface from the driver and terminates any PPP
 106 sessions that were using the interface. The \fIinterface\fR parameter is the
 107 name of the interface as reported when the interface was plumbed.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBsppptun query\fR\fR
 114 .ad
 115 .sp .6
 116 .RS 4n
 117 Displays the canonical names of all interfaces plumbed into the
 118 \fB/dev/sppptun\fR device driver.
 119 .RE
 120
 121 .SH EXAMPLES
 122 .LP
 123 \fBExample 1 \fRSetting up to Use PPPoE on \fBhme0\fR
 124 .sp
 125 .LP
 126 Plumb the \fBhme0\fR interface.
 127
 128 .sp
 129 .in +2
 130 .nf
 131 # \fBsppptun plumb pppoed hme0\fR
 132 hme0:pppoed
 133 # \fBsppptun plumb pppoe hme0\fR
 134 hme0:pppoe
 135 .fi
 136 .in -2
 137 .sp
 138
 139 .sp
 140 .LP
 141 Remove the \fBhme0\fR interface.
 142
 143 .sp
 144 .in +2
 145 .nf
 146 # \fBsppptun unplumb hme0:pppoed\fR
 147 # \fBsppptun unplumb hme0:pppoe\fR
 148 .fi
 149 .in -2
 150 .sp
 151
 152 .LP
 153 \fBExample 2 \fRScript to Remove All Plumbed Interfaces
 154 .sp
 155 .in +2
 156 .nf
 157 #!/bin/sh
 158 for intf in `sppptun query`
 159 do
 160         sppptun unplumb $intf
 161 done
 162 .fi
 163 .in -2
 164 .sp
 165
 166 .LP
 167 \fBExample 3 \fRInteroperating with 3COM HomeConnect Dual Link ADSL
 168 .sp
 169 .in +2
 170 .nf
 171 # \fBdladm show-link\fR
 172 LINK        CLASS    MTU    STATE    OVER
 173 nge0        phys     1500   up       --
 174 # \fBecho nge0 3c13 3c12 > /etc/ppp/pppoe.if\fR
 175 .fi
 176 .in -2
 177 .sp
 178
 179 .SH EXIT STATUS
 180 .sp
 181 .LP
 182 The following exit values are returned:
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB0\fR\fR
 187 .ad
 188 .RS 5n
 189 Successful completion.
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fB1\fR\fR
 196 .ad
 197 .RS 5n
 198 One or more errors occurred.
 199 .RE
 200
 201 .SH FILES
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB/etc/ppp/pppoe.if\fR\fR
 206 .ad
 207 .RS 21n
 208 list of Ethernet interfaces to be plumbed at boot time
 209 .RE
 210
 211 .sp
 212 .ne 2
 213 .na
 214 \fB\fB/usr/sbin/sppptun\fR\fR
 215 .ad
 216 .RS 21n
 217 executable command
 218 .RE
 219
 220 .sp
 221 .ne 2
 222 .na
 223 \fB\fB/dev/sppptun\fR\fR
 224 .ad
 225 .RS 21n
 226 Solaris PPP tunneling device driver
 227 .RE
 228
 229 .SH SEE ALSO
 230 .sp
 231 .LP
 232 \fBpppd\fR(1M), \fBpppoec\fR(1M), \fBpppoed\fR(1M), \fBsppptun\fR(7M)
 233 .sp
 234 .LP
 235 \fIRFC 2516, Method for Transmitting PPP Over Ethernet (PPPoE)\fR, Mamakos et
 236 al, February 1999