Docs/nsctl.8

   1 .\" -*- nroff -*-
   2 .de Id
   3 .ds Dt \\$4 \\$5
   4 ..
   5 .Id $Id: nsctl.8,v 1.2 2004/11/17 15:08:19 bodea Exp $
   6 .TH NSCTL 8 "\*(Dt" L2TPNS "System Management Commands"
   7 .SH NAME
   8 nsctl \- manage running l2tpns instance
   9 .SH SYNOPSIS
  10 .B nsctl
  11 .RB [ \-d ]
  12 .RB [ \-h
  13 .IR host [: port ]]
  14 .RB [ \-t
  15 .IR timeout ]
  16 .I command
  17 .RI [ arg " ...]"
  18 .SH DESCRIPTION
  19 .B nsctl
  20 sends commands to a running
  21 .B l2tpns
  22 process.  It provides both for the loading or unloading of plugins and
  23 also the management of sessions via functions provided by those plugins.
  24 .SH OPTIONS
  25 .TP
  26 .B \-d
  27 Enable debugging output.
  28 .TP
  29 .B \-h \fIhost\fR[:\fIport\fR]
  30 The host running
  31 .B l2tpns
  32 that should receive the message.  By default the message is sent to
  33 UDP port 1702 on
  34 .BR localhost .
  35 .TP
  36 .B \-t \fItimeout\fR
  37 Timeout in seconds to wait for a response from the server.
  38 .SH COMMANDS
  39 The first argument specifies the command to send to
  40 .B l2tpns .
  41 The following commands are as defined:
  42 .TP
  43 .BI "load_plugin " plugin
  44 Load the named
  45 .IR plugin .
  46 .TP
  47 .BI "unload_plugin " plugin
  48 Unload the named
  49 .IR plugin .
  50 .TP
  51 .B help
  52 Each loaded plugin is queried for what commands it supports and the
  53 synopsis for each is output.
  54 .PP
  55 Any other value of
  56 .I command
  57 (and
  58 .I args
  59 if any)
  60 are sent to
  61 .B l2tpns
  62 as-is, to be passed to each plugin which registers a
  63 .B plugin_control
  64 function in turn (in which it may be acted upon).
  65 .SH SEE ALSO
  66 .BR l2tpns (8)
  67 .SH AUTHOR
  68 This manual page was written by Jonathan McDowell <noodles@the.earth.li>,
  69 for the Debian GNU/Linux system (but may be used by others).