IONADMIN(1)

📦 version 3.2.1, in ubuntu jammy

💖 IONADMIN(1) — bestie's guide to the ION node administration interface 💖

okay so this is ionadmin from the ICI executables set, and it is literally the main character of your ION node's whole life. Sit down, grab a 🍓, and let's get into it.

✨ NAME ✨

ionadmin — the ION node administration interface. That's the whole vibe. 👑

🌈 SYNOPSIS 🌈

ionadmin [ commands_filename | . ]

yeah that's it. one optional lil arg. she's simple but she's powerful.

🦋 DESCRIPTION 🦋

ionadmin configures, starts, manages, and stops the ION node on the local computer. She does it all, no cap.

She configures the node and sets (and reports on) global operational settings for the DTN protocol stack on the local computer, and she does that in response to the ION configuration commands she finds in commands_filename — if you gave her one. If you did not give her one, she prints a simple prompt (:) so you can type commands directly into standard input. interactive bestie mode activated 💅

And if commands_filename is a period (.), the effect is the same as if a command file containing the single command x were passed to ionadmin — that is, the ION node's rfxclock task is stopped. one lil dot and the clock stops. dramatic? yes. correct? also yes.

The format of commands for commands_filename can be queried from ionadmin by entering the command h or ? at the prompt. iykyk — the commands themselves are documented in ionrc(5).

okay now here's the part where you gotta pay attention bestie, this is highkey important:

Note that ionadmin always computes a congestion forecast immediately before exiting. 🧠✨ The result of this forecast — the maximum projected occupancy of the DTN protocol traffic allocation in ION's SDR database — is retained for application flow control purposes.

So here's the tea: if maximum projected occupancy is the entire protocol traffic allocation, then a message to this effect is logged, and no new bundle origination by any application will be accepted until a subsequent forecast that predicts no congestion is computed. not me getting locked out of sending bundles 💀

(Congestion forecasts are constrained by horizon times, which can be established by commands issued to ionadmin. One way to re-enable data origination temporarily while long-term traffic imbalances are being addressed is to declare a congestion forecast horizon in the near future, before congestion would occur if no adjustments were made.) 🕐🌸

⭐ EXIT STATUS ⭐

  • "0" — Successful completion of ION node administration. we love a clean exit.

🎀 EXAMPLES 🎀

  • ionadmin Enter interactive ION configuration command entry mode. just you and the : prompt, vibing.
  • ionadmin host1.ion Execute all configuration commands in host1.ion, then terminate immediately. in and out, no small talk.

🫶 FILES 🫶

Status and diagnostic messages from ionadmin and from other software that utilizes the ION node are nominally written to a log file in the current working directory within which ionadmin was run. That log file is typically named ion.log. 📓✨

See also ionconfig(5) and ionrc(5).

🌸 ENVIRONMENT 🌸

Environment variables ION_NODE_LIST_DIR and ION_NODE_WDNAME can be used to enable the operation of multiple ION nodes on a single workstation computer. multiple nodes?! on ONE machine?! slay. See section 2.1.3 of the ION Design and Operations Guide for details.

💀 DIAGNOSTICS 💀

Note: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited. If you edit the ionrc file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to ionadmin. Otherwise ionadmin will detect syntax errors and will not function satisfactorily. fr fr, do the conversion, don't make her suffer.

The following diagnostics may be issued to the log file:

  • Can't open command file... The commands_filename specified in the command line doesn't exist. she looked. it wasn't there. 🙈
  • ionadmin SDR definition failed. A node initialization command was executed, but an SDR database already exists for the indicated node. It is likely that an ION node is already running on this computer, or that destruction of a previously started the previous ION node was incomplete. For most ION installations, incomplete node destruction can be repaired by (a) killing all ION processes that are still running and then (b) using ipcrm to remove all SVr4 IPC objects owned by ION.
  • ionadmin can't get SDR parms. A node initialization command was executed, but the ion_config_filename passed to that command contains improperly formatted commands. Please see ionconfig(5) for further details.
  • Various errors that don't cause ionadmin to fail but are noted in the log file may be caused by improperly formatted commands given at the prompt or in the commands_filename. Please see ionrc(5) for details.

😭 BUGS 😭

If the ion_config_filename parameter passed to a node initialization command refers to a nonexistent filename, then ionadmin uses default values are used rather than reporting an error in the command line argument. yeah she just... quietly uses defaults. no warning. iconic behavior, honestly.

Report bugs to <ion-bugs@korgano.eecs.ohiou.edu> 📧

👑 SEE ALSO 👑

ionrc(5), ionconfig(5)

and that's the whole page, bestie!! this IONADMIN(1) page came to you courtesy of the ICI executables, and it was last updated 2016-07-07 — the version tag on the bottom says perl v5.24.1. go forth and administer your node, you absolute legend 🦋✨💖

📦 where this page comes from