System Administration Commands                        sppptun(1M)



NAME
     sppptun - P 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   P   tunneling   device   driver,   /dev/sppptun.
     Currently, only P over Ethernet (PoE) is  supported,  so
     the plumb and unplumb arguments are used to specify Ethernet
     interfaces that are to be used  for  PoE,  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 P are run over  a  single  inter-
     face,  they  share  the plumbing to that interface. Plumbing
     for each session is  not  required  (and  not  possible  for
     PoE).


     The proper way to plumb interfaces for PoE 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 pro-
         tocol argument below.


     sppptun plumb protocol device

         This plumbs a new interface into the driver. The  proto-
         col  parameter  is  pppoe  for the P-carrying "Session
         Stage" connection or pppoed  for  the  PoE  "Discovery



SunOS 5.11          Last change: 19 Mar 2001                    1






System Administration Commands                        sppptun(1M)



         Stage"  connection. Both connections must be present for
         each Ethernet interface that is to be  used  for  PoE.
         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 por-
         tion may be omitted.


     sppptun unplumb interface

         This removes an existing interface from the  driver  and
         terminates  any  P sessions that were using the inter-
         face. The interface parameter is the name of the  inter-
         face 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 PoE 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



SunOS 5.11          Last change: 19 Mar 2001                    2






System Administration Commands                        sppptun(1M)



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 P tunneling device driver


ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Availability                 SUNWpppdt                   
    


SEE ALSO
     pppd(1M), pppoec(1M), pppoed(1M), sppptun(7M)


     RFC 2516, Method for Transmitting P Over Ethernet (PoE),
     Mamakos et al, February 1999
















SunOS 5.11          Last change: 19 Mar 2001                    3