Docs/l2tpns.8.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 l2tpns - Layer 2 tunneling protocol network server (LNS)
   6
   7 =head1 SYNOPSIS
   8
   9 B<l2tpns> [-B<d>] [-B<v>] [-B<c> I<file>] [-B<h> I<hostname>]
  10
  11 =head1 DESCRIPTION
  12
  13 B<l2tpns> is a daemon for terminating layer 2 tunneling protocol (L2TP: RFC2661) sessions.
  14
  15 B<l2tpns> is a complete L2TP implementation. It supports the LAC, LNS, PPPOE and DHCPv6 server.
  16
  17 Once running, B<l2tpns> may be controlled by telnetting to port 23 on the machine running the daemon and with the B<nsctl> utility.
  18
  19 =head1 OPTIONS
  20
  21 =over
  22
  23 =item B<-d>     Detach from terminal and fork into the background. By default l2tpns will stay in the foreground.
  24
  25 .
  26
  27 =item B<-v>     Increase verbosity for debugging. Can be used multiple times.
  28
  29 .
  30
  31 =item B<-c> I<file>
  32
  33 Specify configuration file.
  34
  35 =item B<-h> I<hostname>
  36
  37 Force hostname to I<hostname>.
  38
  39 =back
  40
  41 =head1 FILES
  42
  43 =over
  44
  45 =item I</etc/l2tpns/startup-config>
  46
  47 The default configuration file.
  48
  49 =item I</etc/l2tpns/ip_pool>
  50
  51 IP address pool configuration.
  52
  53 =item I</etc/l2tpns/users>
  54
  55 Username/password configuration for access to admin interface.
  56
  57 =back
  58
  59 =head1 SIGNALS
  60
  61 =over
  62
  63 =item B<SIGHUP> Reload the config from disk and re-open log file.
  64
  65 .
  66
  67 =item B<SIGTERM>, B<SIGINT>
  68
  69 Stop process. Tunnels and sessions are not terminated. This signal should be used to stop l2tpns on a cluster node where there are other machines to continue handling traffic.
  70
  71 =item B<SIGQUIT>
  72
  73 Shut down tunnels and sessions, exit process when complete.
  74
  75 =back
  76
  77 =head1 MANAGED RADIUS ATTRIBUTE
  78
  79 =over
  80
  81 =item B<Ascend-Client-Primary-DNS>, B<Ascend-Client-Secondary-DNS>
  82
  83 Specifies a primary and secondary DNS server address to send to user.
  84
  85 =item B<Delegated-IPv6-Prefix>
  86
  87 Assign a network address IPv6 prefix to a user by DHCPv6.
  88
  89 =item B<Framed-IP-Address>
  90
  91 The address to be configured for the user (IPv4 address of the interface ppp).
  92
  93 =item B<Framed-Route>
  94
  95 provides routing information to be configured for the user.
  96
  97 =item B<Framed-IPv6-Route>
  98
  99 Has the same action as B<Delegated-IPv6-Prefix>. B<Delegated-IPv6-Prefix> is the correct one to use.
 100
 101 =item B<Framed-IPv6-Address>
 102
 103 IPv6 address to be assigned to the user by DHCPv6 (IPv6 address of the interface ppp).
 104
 105 =item B<Idle-Timeout>
 106
 107 disconnects the session if no data for more than B<Idle-Timeout> (in seconds).
 108
 109 =item B<Session-Timeout>
 110
 111 disconnects the user session when the time B<Session-Timeout> is reached (in seconds).
 112
 113 =item B<Tunnel-Type>, B<Tunnel-Medium-Type>, B<Tunnel-Server-Endpoint>, B<Tunnel-Password>, B<Tunnel-Assignment-Id>
 114
 115 attributes returned by the Radius of the remote LNS server (LAC functionality).
 116
 117 example, Radius that return the information of 2 remote LNS server with which must be open a L2TP TUNNEL:
 118
 119 =over
 120
 121 =item   B<Tunnel-Type>: 1 = L2TP
 122
 123 =item   B<Tunnel-Medium-Type>: 1 = IPv4
 124
 125 =item   B<Tunnel-Password>: 1 = "TheSecretL2TP"
 126
 127 =item   B<Tunnel-Server-Endpoint>: 1 = "88.xx.xx.x1"
 128
 129 =item   B<Tunnel-Assignment-Id>: 1 = "friendisp_lns1"
 130
 131 =item   B<Tunnel-Type>: 2 = L2TP
 132
 133 =item   B<Tunnel-Medium-Type>: 2 = IPv4
 134
 135 =item   B<Tunnel-Password>: 2 = "TheSecretL2TP"
 136
 137 =item   B<Tunnel-Server-Endpoint>: 2 = "88.xx.xx.x2"
 138
 139 =item   B<Tunnel-Assignment-Id>: 2 = "friendisp_lns2"
 140
 141 =back
 142
 143 =back
 144
 145 =head1 SEE ALSO
 146
 147 B<startup-config>(5), B<nsctl>(8)
 148
 149 =head1 AUTHOR
 150
 151 This manual page was written by Jonathan McDowell <noodles@earth.li> and Fernando Alves (fendo@sameswifi.fr), for the Debian GNU/Linux system (but may be used by others).