51 lines
1.6 KiB
Groff
51 lines
1.6 KiB
Groff
.SH NAME
|
|
.PP
|
|
nsctl - manage running l2tpns instance
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[B]nsctl\f[R] [\f[B]-d\f[R]] [\f[B]-h\f[R]
|
|
\f[I]host\f[R][:\f[I]port\f[R]]] [\f[B]-t\f[R] \f[I]timeout\f[R]]
|
|
\f[I]command\f[R] [\f[I]arg\f[R] ...]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\f[B]nsctl\f[R] sends commands to a running \f[B]l2tpns\f[R] process.
|
|
It provides both for the loading or unloading of plugins and also the
|
|
management of sessions via functions provided by those plugins.
|
|
.SH OPTIONS
|
|
.TP
|
|
\f[B]-d\f[R]
|
|
Enable debugging output.
|
|
.TP
|
|
\f[B]-h \f[BI]host\f[B][:\f[BI]port\f[B]]\f[R]
|
|
The host running \f[B]l2tpns\f[R] that should receive the message.
|
|
By default the message is sent to UDP port 1702 on \f[B]localhost\f[R].
|
|
.TP
|
|
\f[B]-t \f[BI]timeout\f[B]\f[R]
|
|
Timeout in seconds to wait for a response from the server.
|
|
.SH COMMANDS
|
|
.PP
|
|
The first argument specifies the command to send to \f[B]l2tpns .\f[R]
|
|
The following commands are as defined:
|
|
.TP
|
|
\f[B]load_plugin \f[R]\f[I]plugin\f[R]
|
|
Load the named \f[I]plugin\f[R].
|
|
.TP
|
|
\f[B]unload_plugin \f[R]\f[I]plugin\f[R]
|
|
Unload the named \f[I]plugin\f[R].
|
|
.TP
|
|
\f[B]help\f[R]
|
|
Each loaded plugin is queried for what commands it supports and the
|
|
synopsis for each is output.
|
|
.PP
|
|
Any other value of \f[I]command\f[R] (and \f[I]args\f[R] if any) are
|
|
sent to \f[B]l2tpns\f[R] as-is, to be passed to each plugin which
|
|
registers a \f[B]plugin_control\f[R] function in turn (in which it may
|
|
be acted upon).
|
|
.SH SEE ALSO
|
|
.PP
|
|
\f[B]l2tpns\f[R](8)
|
|
.SH AUTHOR
|
|
.PP
|
|
This manual page was written by Jonathan McDowell
|
|
<noodles\[at]the.earth.li>, for the Debian GNU/Linux system (but may be
|
|
used by others).
|