IPNADMIN(1)

📦 version 3.2.1, in ubuntu jammy

💖 IPNADMIN(1) — bestie's guide to the IPN scheme admin interface 💖

so this is ipnadmin, aka the Interplanetary Internet (IPN) scheme administration interface — part of the BP executables fam. 🛰️✨

🌸 NAME 🌸

ipnadmin — the Interplanetary Internet (IPN) scheme administration interface, fr fr. it's the girlboss who runs the routing paperwork for your local ION node. 💅

✨ SYNOPSIS ✨

ipnadmin [ commands_filename ]

🦋 DESCRIPTION 🦋

okay so ipnadmin configures how your local ION node routes bundles to endpoints whose IDs conform to the ipn endpoint ID scheme. and ipn is a CBHE-conformant scheme, which lowkey means every single endpoint ID in the ipn scheme is a string shaped exactly like this:

"ipn:node_number.service_number"

where node_number is a CBHE "node number" and service_number identifies a specific application processing point. 👑

ipnadmin operates in response to IPN scheme configuration commands found in the file commands_filename, if you provided one. if you did not, no worries bestie — it prints a simple prompt (:) so you can type commands directly into standard input. it's giving interactive main character energy. 💬

the format of commands for commands_filename can be queried straight from ipnadmin with the 'h' or '?' commands at the prompt. and all those commands are documented in ipnrc(5). go read it, iykyk. 📖

👑 EXIT STATUS 👑

  • "0" — Successful completion of IPN scheme administration. slay. 🎀
  • "1" — Unsuccessful completion of IPN scheme administration, due to inability to attach to the Bundle Protocol system or to initialize the IPN scheme. 💀

🌈 EXAMPLES 🌈

example one:

ipnadmin

Enter interactive IPN scheme configuration command entry mode. just you, the prompt, and your dreams. ✨

example two:

ipnadmin host1.ipnrc

Execute all configuration commands in host1.ipnrc, then terminate immediately. in-and-out, no notes. 🔥

🎀 FILES 🎀

See ipnrc(5) for details of the IPN scheme configuration commands. that's the whole vibe. 🫶

🧚 ENVIRONMENT 🧚

No environment variables apply. literally none. not a single one. it said what it said. 💜

💅 DIAGNOSTICS 💅

Note: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited. if you edit the ipnrc file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to ipnadmin. otherwise ipnadmin will detect syntax errors and will not function satisfactorily. 😭 do not skip the dos2unix step, i am begging.

The following diagnostics may be issued to the logfile ion.log:

  • ipnadmin can't attach to BP. — Bundle Protocol has not been initialized on this computer. You need to run bpadmin(1) first. 🙈
  • ipnadmin can't initialize routing database. — There is no SDR data store for ipnadmin to use. Please run ionadmin(1) to start the local ION node. 🌱
  • Can't open command file... — The commands_filename specified in the command line doesn't exist. 💀

Various errors that don't cause ipnadmin to fail but are noted in the ion.log log file may be caused by improperly formatted commands given at the prompt or in the commands_filename file. Please see ipnrc(5) for details. translation: it'll still run, it'll just complain in the group chat. 💬

⭐ BUGS ⭐

Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>. tell them bestie sent you. 🐛💖

🔥 SEE ALSO 🔥

and that's the whole page, bestie!! 🦋 this one shipped as perl v5.24.1, dated 2016-07-07, under the IPNADMIN(1) manual page from the BP executables — so yeah, it's been iconic since 2016 and it's still iconic now. periodt. 💅✨🌸

📦 where this page comes from