o2cb(8)

✨ NAME ✨

o2cb — the cluster registration utility for the O2CB cluster stack, and honestly? she does a lot. 🫶

---

🌸 SYNOPSIS 🌸

o2cb [--config-file=path] [-h|--help] [-v|--verbose] [-V|--version]
COMMAND [ARGS]

---

💅 DESCRIPTION 💅

So bestie, o2cb(8) is the girl who handles all the info in the O2CB cluster configuration file — she adds stuff, removes stuff, and lists stuff. That's her whole job and she's obsessed with it.

She's also the one you call to register and unregister the cluster, plus start and stop global heartbeat. Like, she's the main character of cluster setup, periodt.

The config file lives at /etc/ocfs2/cluster.conf by default, but you can override that whole vibe with the --config-file option. 💖

---

🎀 OPTIONS 🎀

• --config-file config-file — point her at a specific path for the configuration file. If you don't say anything, she just uses the default path of /etc/ocfs2/cluster.conf. iykyk.
• -v, --verbose — verbose mode. she'll tell you more about what's happening. 🗣️
• -h, --help — help. she's got you. 🙈
• -V, --version — show the version and exit. iconic behavior.

---

👑 O2CB COMMANDS 👑

• add-cluster cluster-name — adds a cluster to the configuration file. ngl the O2CB config file can hold multiple clusters at once, but here's the catch: only one cluster can be active at any time. so choose wisely bestie 💀
• remove-cluster cluster-name — removes a cluster from the configuration file. heads up, she also takes out all the nodes and heartbeat regions assigned to that cluster. it's a full sweep, no crumbs left.
• add-node cluster-name node-name [--ip ip-address] [--port port] [--number node-number] — adds a node to the cluster in the configuration file. she accepts three optional arguments, and if you don't pass them:
  • ip-address defaults to the one assigned to the node-name
  • port defaults to 7777
  • node-number defaults to the lowest unused node number
• remove-node cluster-name node-name — removes a node from the cluster in the configuration file. bye girl 🦋
• add-heartbeat cluster-name [uuid|device] — adds a heartbeat region to the cluster in the configuration file. 💓
• remove-heartbeat cluster-name [uuid|device] — removes a heartbeat region from the cluster in the configuration file.
• heartbeat-mode cluster-name [local|global] — sets the heartbeat mode for the cluster in the configuration file. pick your fighter ✨
• list-clusters — lists all the cluster names in the configuration file. window shopping 🛍️
• list-cluster cluster-name --oneline — lists all the nodes and heartbeat regions associated with the cluster in the configuration file.
• list-nodes cluster-name --oneline — lists all the nodes associated with the cluster in the configuration file.
• list-heartbeats cluster-name --oneline — lists all the heartbeat regions associated with the cluster in the configuration file.
• register-cluster cluster-name — registers the cluster listed in the configuration file with configfs. and lowkey if you call it when the cluster is already registered, she'll just update configfs with the current configuration. no drama, she adapts. 💅
• unregister-cluster cluster-name — unregisters the cluster from configfs. she's leaving the group chat.
• start-heartbeat cluster-name — starts global heartbeat on all regions for the cluster as listed in the configuration file. if you run it again, she'll start heartbeat on the new regions and stop on the regions that got removed since. and if global heartbeat hasn't been enabled, she'll silently exit. no fuss, no note, just gone. 💀
• stop-heartbeat cluster-name — stops global heartbeat on all regions for the cluster. same deal: if global heartbeat hasn't been enabled, she silently exits.
• cluster-status [cluster-name] — shows whether the given cluster is offline or online. if you don't give her a cluster, she shows the currently active cluster, if there is one. vibe check fr fr 🌈

---

🌟 EXAMPLE 🌟

Wanna create a cluster, mycluster, with two nodes, node1 and node2? do this:

$ o2cb add-cluster mycluster
$ o2cb add-node mycluster node1 --ip 10.10.10.1
$ o2cb add-node mycluster node2 --ip 10.10.10.2

Wanna specify a global heartbeat device, /dev/sda1? do this:

$ o2cb add-heartbeat mycluster /dev/sda1

Wanna enable global heartbeat? do this:

$ o2cb heartbeat-mode mycluster global

ate and left no crumbs 🔥

---

🧚 SEE ALSO 🧚

o2cb(7) o2cb.sysconfig(5) ocfs2.cluster.conf(5)

---

💜 AUTHORS 💜

Oracle Corporation

---

🌸 COPYRIGHT 🌸

Copyright © 2010, 2012 Oracle. All rights reserved.

---

and that's the whole page bestie 💖 Version 1.8.9, January 2012 — she's been serving since day one and she's still that girl. go configure something, ily, bye 🎀✨