bluechi-is-online(1)

📦
version 1.3.0 · 2 versions
, in fedora 43, fedora 44

💖 bluechi-is-online(1) — General Commands Manual 💖

okay bestie, gather round, because this little tool is genuinely iconic and also lives in section 1 of the manual (General Commands Manual, she's a classic).

✨ NAME ✨

bluechi-is-online — the command line tool that checks on and monitors the connection state of BlueChi's core components. like a vibe check but for your cluster 🫶

🌸 SYNOPSIS 🌸

bluechi-is-online [system|node|agent] [options]

🦋 DESCRIPTION 🦋

Eclipse BlueChi™ is a systemd service controller, and she's built for multi-node environments — you know, the ones with a predefined number of nodes and a whole focus on highly regulated environments, like the ones that need functional safety (cars, for example 🚗✨).

So bluechi-is-online is the command line tool that checks and monitors the connection state of BlueChi's core components. She talks to the public D-Bus API that bluechi-controller and/or bluechi-agent provide. no cap.

bluechi-is-online [OPTIONS]

💅 OPTIONS 💅

  • --help, -h — prints the usage statement and dips out. bye! 👋
  • --version, -v — prints the current bluechictl version. slay.

🎀 Commands 🎀

  • bluechi-is-online system [options] — checks the connection state of bluechi-controller and all the expected bluechi-agents. she runs on the primary node. uses the D-Bus property Status of the org.eclipse.bluechi.Controller interface. if Status is up, exit code is 0. otherwise? 1. simple as. 💀

Options:

  • --wait — initial time in milliseconds to wait until the expected system status is up.
  • --monitor — if set, bluechi-is-online continuously monitors the system state after that initial up check succeeded. she's watching 👀
  • bluechi-is-online node [node_name] [options] — checks the connection state of one specific node. runs on the primary node. uses the D-Bus property Status of the org.eclipse.bluechi.Node interface. if Status is online, exit code is 0. otherwise 1. periodt.

Options:

  • --wait — initial time in milliseconds to wait until the expected node status is online.
  • --monitor — if set, bluechi-is-online continuously monitors the node state after the initial online check succeeded.
  • bluechi-is-online agent [options] — checks the connection state of the bluechi-agent with the controller. this one runs on any managed node. uses the D-Bus property Status of the org.eclipse.bluechi.Agent interface. if Status is online, exit code is 0. otherwise 1.

Options:

  • --wait — initial time in milliseconds to wait until the expected agent status is online.
  • --monitor — if set, bluechi-is-online continuously monitors the agent state after the initial online check succeeded.
  • --switch-timeout — time to wait until the agent is expected to connect again on a call to the SwitchController API method. in milliseconds. ⏱️

🔥 Exit Codes 🔥

If the respective BlueChi component is online at the time of exiting, 0 is returned. Otherwise, 1 is returned. that's it, that's the whole tea. 🍓

and that's the page bestie!! 🎀 this one's bluechi-is-online(1) from the General Commands Manual — she's giving main character energy in section 1, and this whole thing is signed off with that classic bluechi-is-online(1) footer vibe. go check your cluster, i believe in you 💜✨

📦 where this page comes from