BPADMIN(1)

📦 version 3.2.1, in ubuntu jammy

💅 bpadmin — the ION Bundle Protocol (BP) administration interface, section 1 of the manual, bestie 💖

okay so real talk, this is bpadmin, and she is THE girl for running Bundle Protocol stuff on your local ION node. configures it, starts it, manages it, stops it. all of it. let's get into it 🦋

✨ NAME ✨

bpadmin — the ION Bundle Protocol (BP) administration interface. that's her. that's the whole name. slay.

🌸 SYNOPSIS 🌸

bpadmin [ commands_filename | . ]

🎀 DESCRIPTION 🎀

bpadmin configures, starts, manages, and stops bundle protocol operations for the local ION node. it's giving main character energy for your whole BP setup, no cap.

she operates in response to the BP configuration commands she finds in the file commands_filename, if you gave her one. and if you didn't? she just prints a little prompt (:) so you can type commands straight into standard input like the icon you are. 💅

and if commands_filename is a period (.)? oh bestie, that's a whole mood. the effect is the same as if a command file containing the single command x were passed to bpadmin — which means the ION node's bpclock task, forwarder tasks, and convergence layer adapter tasks are stopped. all of them. at once. 💀

the format of commands for commands_filename can be queried from bpadmin with the h or ? commands at the prompt. the commands themselves are documented in bprc(5). iykyk.

⭐ EXIT STATUS ⭐

  • "0" — successful completion of BP administration. we love a clean exit 🫶

🌈 EXAMPLES 🌈

  • bpadmin — enter interactive BP configuration command entry mode. just you, the prompt, and unlimited potential ✨
  • bpadmin host1.bp — execute all configuration commands in host1.bp, then terminate immediately. she's efficient, she's got places to be 💅
  • bpadmin . — stop all bundle protocol operations on the local node. the shutdown era 😭

🦋 FILES 🦋

see bprc(5) for details of the BP configuration commands. that's where the lore lives 📖

💜 ENVIRONMENT 💜

no environment variables apply. none. zero. she doesn't need them and honestly? iconic of her.

🔥 DIAGNOSTICS 🔥

note: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited. if you edit the bprc file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to bpadmin. otherwise bpadmin will detect syntax errors and will not function satisfactorily. fr fr, convert your line endings, i am begging 🙈

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

  • ION can't set custodian EID information. the custodial_endpoint_id specified in the BP initialization (1) command is malformed. remember that the format for this argument is ipn:element_number.0 and that the final 0 is required, as custodial/administration service is always service 0. additional detail for this error is provided if one of the following other errors is present:
    • Malformed EID.
    • Malformed custodian EID.
  • bpadmin can't attach to ION. there is no SDR data store for bpadmin to use. you should run ionadmin(1) first, to set up an SDR data store for ION. she can't attach to what doesn't exist bestie 😭
  • Can't open command file... the commands_filename specified in the command line doesn't exist. check your spelling, queen 🎀
  • various errors that don't cause bpadmin 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 bprc(5) for details.

💀 BUGS 💀

report bugs to <ion-bugs@korgano.eecs.ohiou.edu> — she wants to hear from you, genuinely 🫶

👑 SEE ALSO 👑

ionadmin(1), bprc(5), ipnadmin(1), ipnrc(5), dtnadmin(1), dtnrc(5)

the whole friend group, basically. go read them all, they're all baddies ✨

and that's the page, bestie!! this was written by perl v5.24.1 and it's dated 2016-07-07, so yeah, she's been serving BP administration realness since 2016 and she has not missed a day. periodt. 💖🎀🦋

📦 where this page comes from