OPENNHRP(8)

📦 version 0.14.1, in alpine 3.22, alpine 3.23, alpine 3.24

💖 OPENNHRP(8) — opennhrpctl: opennhrp administrative control tool 💖

okay bestie, welcome to the OPENNHRP(8) manual page — this one is all about opennhrpctl, the admin control tool that talks to the opennhrp(8) daemon 💅✨

💅 NAME 💅

opennhrpctl — opennhrp administrative control tool 🎀

✨ SYNOPSIS ✨

opennhrpctl [-a admin-socket] command [arguments]...

🌸 DESCRIPTION 🌸

opennhrpctl is the utility you use to control what opennhrp(8) is doing 🫶 A UNIX socket is the communication glow-up between opennhrpctl and opennhrp(8). Administration privileges for a non-root user can be granted by modifying the permissions and ownership of the socket — yes, that’s the whole vibe 💫

These are the commands, bestie:

  • [cache] show [selector]... — show the contents of the next hop cache, aka configured and resolved entries 👀
  • [cache] flush [selector]... — clear all non-permanent entries that match the selector specifiers 🧹
  • [cache] purge [selector]... — purge entries from the NHRP cache: cached entries are removed, and permanent entries are forced down, up, and finally reregistered 🔁
  • [cache] lowerdown [selector]... — purge entries from the NHRP cache with an indication that the lower layer failed, e.g. the IPsec daemon detected dead-peer or received INITIIAL-CONTACT notification 💀
  • route show [selector]... — show the contents of locally cached kernel routing information (the outbound routing base for doing route lookups, excluding active shortcut routes) 🛣️
  • interface show — show the contents of the interface configuration table, plus the cached information from the kernel (like protocol and NBMA IP addresses in use currently) 🦋
  • redirect purge [protocol-address/prefix-length] — clear the redirection cache from all entries matching the specified address ✨
  • update nbma nbma-address protocol-address — this command can be used from opennhrp-script(8) to inform the opennhrp daemon of the real protocol-address of a dynamically discovered NHS 📣

These selectors can be used to limit which cache entries will be affected:

  • nbma nbma-address — matches entries where the remote has NBMA address nbma-address 🎯
  • protocol protocol-address[/prefix-length] — matches entries where the remote has protocol address protocol-address with at least prefix length prefix-length 🔍
  • local-nbma nbma-address — matches entries from the local interface that owns the NBMA address nbma-address 🏠
  • local-protocol protocol-address — matches entries only from the local interface that owns the protocol address protocol-address 🫶
  • interface interface-name — search entries only from the local interface with name interface-name 💅
  • iface interface-name — same selector energy, same local-interface search by name interface-name 🎀
  • dev interface-name — yep, same thing again: search entries only from the local interface with name interface-name ✨

🎀 FILES 🎀

  • /var/run/opennhrp.socket — the opennhrp(8) control socket 🔌

🦋 SEE ALSO 🦋

👑 AUTHORS 👑

Timo Teras <timo.teras@iki.fi> 💌

okay bestie, that’s the whole page — it comes from OpenNHRP Documentation, dated 20 May 2009, and it’s giving iconic admin-tool energy forever 💅✨🫶

📦 where this page comes from