COROSYNC-CFGTOOL(8)

💖 COROSYNC-CFGTOOL(8) 💖

okay bestie, gather round, because this is the manual page for corosync-cfgtool, and it's genuinely one of the most useful little gremlins in your corosync toolbox. ✨

---

🌸 NAME 🌸

corosync-cfgtool — an administrative tool for corosync.

like, the whole vibe is "I manage corosync for you". that's the job. 💅

---

🦋 SYNOPSIS 🦋

corosync-cfgtool [[-i IP_address] [-b] [-s] [-n] [-R] [-L] [-k nodeid]
[-a nodeid] [-h] [-H] [--force]

yes it's a lot of brackets. it's giving "choose your own adventure". 🎀

---

✨ DESCRIPTION ✨

corosync-cfgtool is the tool for displaying and configuring active parameters within corosync. that's it, that's the whole thing. she shows you stuff, she pokes stuff, she's the main character of your cluster debugging arc. 👑

---

💜 OPTIONS 💜

• -i — finds only info about the interface IP address you specified, or about a link id if you're rolling with -s. so like, one interface, one lil spotlight. 🔍
• -s — displays the status of the current links on this node for UDP/UDPU, with extended status for KNET. after each link, the nodes on that link get listed in order with their status. for example, here's a 3-node setup on KNET transport:

LINK ID 0
        addr    = 192.168.100.80
        status:
                nodeid  1:      localhost
                nodeid  2:      connected
                nodeid  3:      connected

heads up bestie: only one link is returned for a single node cluster configuration, no matter how many links are configured. don't come for me, that's just how it is. 🫶

• -b — displays the brief status of the current links on this node, and only when used with "-s". if any interfaces are faulty, 1 is returned by the binary. if all interfaces are active, 0 is returned to the shell. after each link, the nodes on that link are displayed in order with their status encoded into a single digit, or the characters 'n', 'd' and '?' with special meaning. 1=link enabled, 2=link connected — so a 3 in a node position means that link is both enabled and connected. status represented by the character 'n' is used for the localhost link. the character '?' means Corosync was unable to get the status of the link from knet (the log should contain more info). the character 'd' shouldn't appear, and it means Corosync was unable to configure a link and it's the result of some error which should have been logged.

the output will be:

LINK ID 0
        addr    = 192.168.100.80
        status  = n33

no cap, one little string and you know everything. iconic. 💅

• -n — displays the status of the current nodes in the system with their link status(es).

Local node ID 1, transport knet
nodeid: 2 reachable   onwire (min/max/cur): 0, 1, 1
   LINK: 0 (192.168.1.101->192.168.1.102)  enabled connected mtu: 1397
   LINK: 1 (192.168.4.1->192.168.4.2)  enabled mtu: 469
   LINK: 2 (192.168.9.1->192.168.9.2)  enabled mtu: 469

only reachable nodes are displayed, so "reachable" should always be there, fr fr.

‘onwire’ versions are the knet on-wire versions that are supported/in use (where appropriate).

IP addresses are the local and remote IP addresses (for UDP[U] only the local IP address is shown).

enabled — means the link has been brought up.

connected — means that the link is connected to the remote node.

dynconnected — is not currently implemented. (she's a work in progress, be nice 😭)

mtu — shows the size of data packets. should be the link packet size less a small amount for protocol overheads and encryption.

• -R — tell all instances of corosync in this cluster to reload corosync.conf. 🎀

⚠️ running corosync-cfgtool -R where nodes are running different versions of corosync (including minor versions) is unsupported and may result in undefined behaviour. like, please don't. matching versions only. 🙈

• -L — tell corosync to reopen all logging files. in contrast to other subcommands, nothing is displayed on terminal if the call is successful. silent queen. she ate and left no crumbs. 💀✨
• -k — kill a node identified by node id. that node is done, bestie. 💅
• -a — display the IP address(es) of a node. 🦋
• -h — print basic usage. your lil helper. 🌸
• -H — shutdown corosync cleanly on this node. corosync-cfgtool -H will request a shutdown from corosync, which means it will consult any interested daemons before shutting down, and the shutdown may be vetoed if a daemon regards the shutdown as inappropriate. if --force is added to the command line, then corosync will shutdown regardless of the daemons' opinions on the matter. 😤 like, no thoughts, just shutdown.

---

🔥 SEE ALSO 🔥

corosync_overview(7),

(yeah that's it, that's the list, she's a short one 🎀)

---

👑 AUTHOR 👑

Angus Salkeld

---

and that's the whole page, bestie!! 🌈💖

this manual page was living her best life on 2020-06-02, and the source/version on the footer says COROSYNC-CFGTOOL(8). go forth and check your links. slay. 💅✨🦋🌸