Docs/l2tpns.8

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "L2TPNS.8 1"
 136 .TH L2TPNS.8 1 "2014-09-14" "perl v5.20.2" "User Contributed Perl Documentation"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 l2tpns \- Layer 2 tunneling protocol network server (LNS)
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBl2tpns\fR [\-\fBd\fR] [\-\fBv\fR] [\-\fBc\fR \fIfile\fR] [\-\fBh\fR \fIhostname\fR]
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fBl2tpns\fR is a daemon for terminating layer 2 tunneling protocol (L2TP: \s-1RFC2661\s0) sessions.
 149 .PP
 150 \&\fBl2tpns\fR is a complete L2TP implementation. It supports the \s-1LAC, LNS, PPPOE\s0 and DHCPv6 server.
 151 .PP
 152 Once running, \fBl2tpns\fR may be controlled by telnetting to port 23 on the machine running the daemon and with the \fBnsctl\fR utility.
 153 .SH "OPTIONS"
 154 .IX Header "OPTIONS"
 155 .IP "\fB\-d\fR  Detach from terminal and fork into the background. By default l2tpns will stay in the foreground." 4
 156 .IX Item "-d Detach from terminal and fork into the background. By default l2tpns will stay in the foreground."
 157 \&.
 158 .IP "\fB\-v\fR  Increase verbosity for debugging. Can be used multiple times." 4
 159 .IX Item "-v Increase verbosity for debugging. Can be used multiple times."
 160 \&.
 161 .IP "\fB\-c\fR \fIfile\fR" 4
 162 .IX Item "-c file"
 163 Specify configuration file.
 164 .IP "\fB\-h\fR \fIhostname\fR" 4
 165 .IX Item "-h hostname"
 166 Force hostname to \fIhostname\fR.
 167 .SH "FILES"
 168 .IX Header "FILES"
 169 .IP "\fI/etc/l2tpns/startup\-config\fR" 4
 170 .IX Item "/etc/l2tpns/startup-config"
 171 The default configuration file.
 172 .IP "\fI/etc/l2tpns/ip_pool\fR" 4
 173 .IX Item "/etc/l2tpns/ip_pool"
 174 \&\s-1IP\s0 address pool configuration.
 175 .IP "\fI/etc/l2tpns/users\fR" 4
 176 .IX Item "/etc/l2tpns/users"
 177 Username/password configuration for access to admin interface.
 178 .SH "SIGNALS"
 179 .IX Header "SIGNALS"
 180 .IP "\fB\s-1SIGHUP\s0\fR Reload the config from disk and re-open log file." 4
 181 .IX Item "SIGHUP Reload the config from disk and re-open log file."
 182 \&.
 183 .IP "\fB\s-1SIGTERM\s0\fR, \fB\s-1SIGINT\s0\fR" 4
 184 .IX Item "SIGTERM, SIGINT"
 185 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.
 186 .IP "\fB\s-1SIGQUIT\s0\fR" 4
 187 .IX Item "SIGQUIT"
 188 Shut down tunnels and sessions, exit process when complete.
 189 .SH "MANAGED RADIUS ATTRIBUTE"
 190 .IX Header "MANAGED RADIUS ATTRIBUTE"
 191 .IP "\fBAscend-Client-Primary-DNS\fR, \fBAscend-Client-Secondary-DNS\fR" 4
 192 .IX Item "Ascend-Client-Primary-DNS, Ascend-Client-Secondary-DNS"
 193 Specifies a primary and secondary \s-1DNS\s0 server address to send to user.
 194 .IP "\fBDelegated\-IPv6\-Prefix\fR" 4
 195 .IX Item "Delegated-IPv6-Prefix"
 196 Assign a network address IPv6 prefix to a user by DHCPv6.
 197 .IP "\fBFramed-IP-Address\fR" 4
 198 .IX Item "Framed-IP-Address"
 199 The address to be configured for the user (IPv4 address of the interface ppp).
 200 .IP "\fBFramed-Route\fR" 4
 201 .IX Item "Framed-Route"
 202 provides routing information to be configured for the user.
 203 .IP "\fBFramed\-IPv6\-Route\fR" 4
 204 .IX Item "Framed-IPv6-Route"
 205 Has the same action as \fBDelegated\-IPv6\-Prefix\fR. \fBDelegated\-IPv6\-Prefix\fR is the correct one to use.
 206 .IP "\fBFramed\-IPv6\-Address\fR" 4
 207 .IX Item "Framed-IPv6-Address"
 208 IPv6 address to be assigned to the user by DHCPv6 (IPv6 address of the interface ppp).
 209 .IP "\fBIdle-Timeout\fR" 4
 210 .IX Item "Idle-Timeout"
 211 disconnects the session if no data for more than \fBIdle-Timeout\fR (in seconds).
 212 .IP "\fBSession-Timeout\fR" 4
 213 .IX Item "Session-Timeout"
 214 disconnects the user session when the time \fBSession-Timeout\fR is reached (in seconds).
 215 .IP "\fBTunnel-Type\fR, \fBTunnel-Medium-Type\fR, \fBTunnel-Server-Endpoint\fR, \fBTunnel-Password\fR, \fBTunnel-Assignment-Id\fR" 4
 216 .IX Item "Tunnel-Type, Tunnel-Medium-Type, Tunnel-Server-Endpoint, Tunnel-Password, Tunnel-Assignment-Id"
 217 attributes returned by the Radius of the remote \s-1LNS\s0 server (\s-1LAC\s0 functionality).
 218 .Sp
 219 example, Radius that return the information of 2 remote \s-1LNS\s0 server with which must be open a L2TP \s-1TUNNEL:\s0
 220 .RS 4
 221 .IP "\fBTunnel-Type\fR: 1 = L2TP" 4
 222 .IX Item "Tunnel-Type: 1 = L2TP"
 223 .PD 0
 224 .IP "\fBTunnel-Medium-Type\fR: 1 = IPv4" 4
 225 .IX Item "Tunnel-Medium-Type: 1 = IPv4"
 226 .ie n .IP "\fBTunnel-Password\fR: 1 = ""TheSecretL2TP""" 4
 227 .el .IP "\fBTunnel-Password\fR: 1 = ``TheSecretL2TP''" 4
 228 .IX Item "Tunnel-Password: 1 = TheSecretL2TP"
 229 .ie n .IP "\fBTunnel-Server-Endpoint\fR: 1 = ""88.xx.xx.x1""" 4
 230 .el .IP "\fBTunnel-Server-Endpoint\fR: 1 = ``88.xx.xx.x1''" 4
 231 .IX Item "Tunnel-Server-Endpoint: 1 = 88.xx.xx.x1"
 232 .ie n .IP "\fBTunnel-Assignment-Id\fR: 1 = ""friendisp_lns1""" 4
 233 .el .IP "\fBTunnel-Assignment-Id\fR: 1 = ``friendisp_lns1''" 4
 234 .IX Item "Tunnel-Assignment-Id: 1 = friendisp_lns1"
 235 .IP "\fBTunnel-Type\fR: 2 = L2TP" 4
 236 .IX Item "Tunnel-Type: 2 = L2TP"
 237 .IP "\fBTunnel-Medium-Type\fR: 2 = IPv4" 4
 238 .IX Item "Tunnel-Medium-Type: 2 = IPv4"
 239 .ie n .IP "\fBTunnel-Password\fR: 2 = ""TheSecretL2TP""" 4
 240 .el .IP "\fBTunnel-Password\fR: 2 = ``TheSecretL2TP''" 4
 241 .IX Item "Tunnel-Password: 2 = TheSecretL2TP"
 242 .ie n .IP "\fBTunnel-Server-Endpoint\fR: 2 = ""88.xx.xx.x2""" 4
 243 .el .IP "\fBTunnel-Server-Endpoint\fR: 2 = ``88.xx.xx.x2''" 4
 244 .IX Item "Tunnel-Server-Endpoint: 2 = 88.xx.xx.x2"
 245 .ie n .IP "\fBTunnel-Assignment-Id\fR: 2 = ""friendisp_lns2""" 4
 246 .el .IP "\fBTunnel-Assignment-Id\fR: 2 = ``friendisp_lns2''" 4
 247 .IX Item "Tunnel-Assignment-Id: 2 = friendisp_lns2"
 248 .RE
 249 .RS 4
 250 .RE
 251 .PD
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 \&\fBstartup-config\fR(5), \fBnsctl\fR(8)
 255 .SH "AUTHOR"
 256 .IX Header "AUTHOR"
 257 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).