NSCTL(8)

📦
version 2.5.0 · 2 versions
, in ubuntu resolute, ubuntu stonking

💖 NSCTL(8) 💖

okay bestie, buckle up — this is nsctl from section 8 of the manual (you know, the system administration section, main character energy only) ✨

🎀 NAME 🎀

nsctl — manage a running l2tpns instance 🫶

🌸 SYNOPSIS 🌸

nsctl [-d] [-h host[:port]] [-t timeout] command [arg ...]

✨ DESCRIPTION ✨

so basically nsctl slides into a running l2tpns process's DMs and sends it commands. 💌 that's the whole vibe.

and it's giving two things, actually:

  • loading or unloading plugins 🧩
  • managing sessions, via functions that those plugins provide 👑

💅 OPTIONS 💅

  • -d — turns on debugging output. not me turning this on immediately, fr fr 🐛✨
  • -h host[:port] — the host running l2tpns that should receive the message. by default the message is sent to UDP port 1702 on localhost 🏠 (iykyk)
  • -t timeout — timeout in seconds to wait for a response from the server. patience is a virtue but so is a timeout ⏰

👑 COMMANDS 👑

the first argument is literally the command you're sending to l2tpns. here's the lineup, as defined:

  • load_plugin plugin — load the named plugin 🧩💖
  • unload_plugin plugin — unload the named plugin 🧩💔
  • help — every loaded plugin gets queried for what commands it supports, and then the synopsis for each one is output 📖✨

and for literally any other value of command (plus any args if there are any) — those get sent to l2tpns as-is, to be passed to each plugin that registers a plugin_control function, in turn, where it may be acted upon. so it's a lil relay race, no cap 🏃♀️🔥

🦋 SEE ALSO 🦋

🌈 AUTHORS 🌈

this manual page was written by Jonathan McDowell noodles@the.earth.li, for the Debian GNU/Linux system (but may be used by others). iconic of them honestly 🎀

and that's the whole page, bestie 💜 this is the NSCTL(8) page, version/date stamped January 31, 2021, filed under "Manage running l2tpns instance" — slay, go forth and control your plugins 🫶✨

📦 where this page comes from