Tested with: LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man \ --warnings -E UTF-8 -l -Tutf8 -Z docs/manpages/startup-config.5 > /dev/null
184 lines
4.2 KiB
Groff
184 lines
4.2 KiB
Groff
.\" Automatically generated by Pandoc 2.9.2.1
|
|
.\"
|
|
.TH "L2TPNS" "8" "January 31, 2021" "Layer 2 tunneling protocol network server (LNS)" ""
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
l2tpns - Layer 2 tunneling protocol network server (LNS)
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[B]l2tpns\f[R] [-\f[B]d\f[R]] [-\f[B]v\f[R]] [-\f[B]c\f[R]
|
|
\f[I]file\f[R]] [-\f[B]h\f[R] \f[I]hostname\f[R]]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\f[B]l2tpns\f[R] is a daemon for terminating layer 2 tunneling protocol
|
|
(L2TP: RFC2661) sessions.
|
|
.PP
|
|
\f[B]l2tpns\f[R] is a complete L2TP implementation.
|
|
It supports the LAC, LNS, PPPOE and DHCPv6 server.
|
|
.PP
|
|
Once running, \f[B]l2tpns\f[R] may be controlled by telnetting to port
|
|
23 on the machine running the daemon and with the \f[B]nsctl\f[R]
|
|
utility.
|
|
.SH OPTIONS
|
|
.IP \[bu] 2
|
|
\f[B]-d\f[R] Detach from terminal and fork into the background.
|
|
By default l2tpns will stay in the foreground.
|
|
.RS 2
|
|
.PP
|
|
\&.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]-v\f[R] Increase verbosity for debugging.
|
|
Can be used multiple times.
|
|
.RS 2
|
|
.PP
|
|
\&.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]-c\f[R] \f[I]file\f[R]
|
|
.RS 2
|
|
.PP
|
|
Specify configuration file.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]-h\f[R] \f[I]hostname\f[R]
|
|
.RS 2
|
|
.PP
|
|
Force hostname to \f[I]hostname\f[R].
|
|
.RE
|
|
.SH FILES
|
|
.IP \[bu] 2
|
|
\f[I]/etc/l2tpns/startup-config\f[R]
|
|
.RS 2
|
|
.PP
|
|
The default configuration file.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[I]/etc/l2tpns/ip_pool\f[R]
|
|
.RS 2
|
|
.PP
|
|
IP address pool configuration.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[I]/etc/l2tpns/users\f[R]
|
|
.RS 2
|
|
.PP
|
|
Username/password configuration for access to admin interface.
|
|
.RE
|
|
.SH SIGNALS
|
|
.IP \[bu] 2
|
|
\f[B]SIGHUP\f[R] Reload the config from disk and re-open log file.
|
|
.RS 2
|
|
.PP
|
|
\&.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]SIGTERM\f[R], \f[B]SIGINT\f[R]
|
|
.RS 2
|
|
.PP
|
|
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.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]SIGQUIT\f[R]
|
|
.RS 2
|
|
.PP
|
|
Shut down tunnels and sessions, exit process when complete.
|
|
.RE
|
|
.SH MANAGED RADIUS ATTRIBUTE
|
|
.IP \[bu] 2
|
|
\f[B]Ascend-Client-Primary-DNS\f[R],
|
|
\f[B]Ascend-Client-Secondary-DNS\f[R]
|
|
.RS 2
|
|
.PP
|
|
Specifies a primary and secondary DNS server address to send to user.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Delegated-IPv6-Prefix\f[R]
|
|
.RS 2
|
|
.PP
|
|
Assign a network address IPv6 prefix to a user by DHCPv6.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Framed-IP-Address\f[R]
|
|
.RS 2
|
|
.PP
|
|
The address to be configured for the user (IPv4 address of the interface
|
|
ppp).
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Framed-Route\f[R]
|
|
.RS 2
|
|
.PP
|
|
provides routing information to be configured for the user.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Framed-IPv6-Route\f[R]
|
|
.RS 2
|
|
.PP
|
|
Has the same action as \f[B]Delegated-IPv6-Prefix\f[R].
|
|
\f[B]Delegated-IPv6-Prefix\f[R] is the correct one to use.
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Framed-IPv6-Address\f[R]
|
|
.RS 2
|
|
.PP
|
|
IPv6 address to be assigned to the user by DHCPv6 (IPv6 address of the
|
|
interface ppp).
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Idle-Timeout\f[R]
|
|
.RS 2
|
|
.PP
|
|
disconnects the session if no data for more than \f[B]Idle-Timeout\f[R]
|
|
(in seconds).
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Session-Timeout\f[R]
|
|
.RS 2
|
|
.PP
|
|
disconnects the user session when the time \f[B]Session-Timeout\f[R] is
|
|
reached (in seconds).
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Type\f[R], \f[B]Tunnel-Medium-Type\f[R],
|
|
\f[B]Tunnel-Server-Endpoint\f[R], \f[B]Tunnel-Password\f[R],
|
|
\f[B]Tunnel-Assignment-Id\f[R]
|
|
.RS 2
|
|
.PP
|
|
attributes returned by the Radius of the remote LNS server (LAC
|
|
functionality).
|
|
.PP
|
|
example, Radius that return the information of 2 remote LNS server with
|
|
which must be open a L2TP TUNNEL:
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Type\f[R]: 1 = L2TP
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Medium-Type\f[R]: 1 = IPv4
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Password\f[R]: 1 = \[lq]TheSecretL2TP\[rq]
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Server-Endpoint\f[R]: 1 = \[lq]88.xx.xx.x1\[rq]
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Assignment-Id\f[R]: 1 = \[lq]friendisp_lns1\[rq]
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Type\f[R]: 2 = L2TP
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Medium-Type\f[R]: 2 = IPv4
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Password\f[R]: 2 = \[lq]TheSecretL2TP\[rq]
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Server-Endpoint\f[R]: 2 = \[lq]88.xx.xx.x2\[rq]
|
|
.IP \[bu] 2
|
|
\f[B]Tunnel-Assignment-Id\f[R]: 2 = \[lq]friendisp_lns2\[rq]
|
|
.RE
|
|
.SH SEE ALSO
|
|
.PP
|
|
\f[B]startup-config\f[R](5), \f[B]nsctl\f[R](8)
|
|
.SH AUTHORS
|
|
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).
|