PACEMAKER(8)

πŸ’… PACEMAKER (section 8, the System Administration Utilities manual, bestie) πŸŽ€

okay so first things first: Pacemaker is part of the Pacemaker cluster resource manager, and this page is all about the fencing side of it. section 8 manual, system administration utilities, we're in the grown-up section of the man pages and honestly? slay.


✨ SYNOPSIS ✨

stonith_admin <command> [<options>]

that's it. that's the whole shape of it. a command, then options. you got this πŸ’–


🌸 DESCRIPTION 🌸

stonith_admin β€” it gives you access to the Pacemaker fencing API. fencing! the thing that shuts a node down when it's misbehaving. iconic, scary, necessary. no cap. πŸ”₯


πŸ‘‘ OPTIONS πŸ‘‘

🫢 Help Options:

  • -?, --help β€” show help options
  • --help-all β€” show all the help options
  • --help-output β€” show output help
  • --help-definition β€” show device definition help
  • --help-queries β€” show query help
  • --help-fence β€” show fence help
  • --help-additional β€” show additional options

like, there's a help flag for every mood. pick your vibe πŸ’…


πŸŽ€ Output Options:

  • --output-as=*FORMAT β€” specify output format as one of: text (default), html, xml
  • --output-to=*DEST β€” specify file name for output (or - for stdout)
  • --html-cgi β€” add CGI headers (requires --output-as=html)
  • --html-stylesheet=*URI β€” link to an external stylesheet (requires --output-as=html)
  • --html-title=*TITLE β€” specify a page title (requires --output-as=html)
✨ the three --html-* ones literally will not work unless you set --output-as=html. don't come for me, that's just the rules πŸ™ˆ

πŸ¦‹ Device Definition Commands:

  • -R, --register=*DEVICE β€” register the named fencing device. Requires: --agent. Optional: --option, --env-option.
  • -D, --deregister=*DEVICE β€” de-register the named fencing device.
  • -r, --register-level=*TARGET β€” register a fencing level for the named target, specified as one of NAME, @PATTERN, or ATTR=VALUE. Requires: --index and one or more --device entries.
  • -d, --deregister-level=*TARGET β€” unregister a fencing level for the named target, specified as for --register-level. Requires: --index

🧚 Queries:

  • -l, --list=*HOST β€” list devices that can terminate the specified host. Optional: --timeout
  • -L, --list-registered β€” list all registered devices. Optional: --timeout.
  • -I, --list-installed β€” list all installed devices. Optional: --timeout.
  • -s, --list-targets=*DEVICE β€” list the targets that can be fenced by the named device. Optional: --timeout.
  • -M, --metadata β€” show agent metadata. Requires: --agent. Optional: --timeout.
  • -Q, --query=*DEVICE β€” check the named device's status. Optional: --timeout.
  • -H, --history=*NODE β€” show last successful fencing operation for named node (or * for all nodes). Optional: --timeout, --cleanup, --quiet (show only the operation's epoch timestamp), --verbose (show all recorded and pending operations), --broadcast (update history from all nodes available).
  • -h, --last=*NODE β€” indicate when the named node was last fenced. Optional: --as-node-id.
  • -K, --validate β€” validate a fence device configuration. Requires: --agent. Optional: --option, --env-option, --quiet (print no output, only return status).

πŸ”₯ Fencing Commands:

  • -F, --fence=*HOST β€” fence named host. Optional: --timeout, --tolerance, --delay.
  • -U, --unfence=*HOST β€” unfence named host. Optional: --timeout, --tolerance, --delay.
  • -B, --reboot=*HOST β€” reboot named host. Optional: --timeout, --tolerance, --delay.
  • -C, --confirm=*HOST β€” tell cluster that named host is now safely down.
πŸ’€ these are the actually do the thing commands. --fence and --reboot are not a drill, bestie. main character energy but in a "please read twice" way.

πŸ’œ Additional Options:

  • -c, --cleanup β€” cleanup wherever appropriate. Requires --history.
  • -b, --broadcast β€” broadcast wherever appropriate.
  • -a, --agent=*AGENT β€” the agent to use (for example, fence_xvm; with --register, --metadata, --validate).
  • -o, --option=*PARAM β€” specify a device configuration parameter as NAME=VALUE (may be specified multiple times; with --register, --validate).
  • -e, --env-option=*PARAM β€” specify a device configuration parameter with the specified name, using the value of the environment variable of the same name prefixed with OCF_RESKEY_ (may be specified multiple times; with --register, --validate).
  • -T, --tag=*TAG β€” identify fencing operations in logs with the specified tag; useful when multiple entities might invoke stonith_admin (used with most commands).
  • -v, --device=*DEVICE β€” device ID (with --register-level, device to associate with a given host and level; may be specified multiple times) (with --validate, name to use to load CIB secrets).
  • -i, --index=*LEVEL β€” the fencing level (1-9) (with --register-level, --deregister-level).
  • -t, --timeout=*SECONDS β€” operation timeout in seconds (default 120; used with most commands).
  • -y, --delay=*SECONDS β€” apply a fencing delay in seconds. Any static/random delays from pcmk_delay_base/max will be added, otherwise all disabled with the value -1 (default 0; with --fence, --reboot, --unfence).
  • -n, --as-node-id β€” (Advanced) the supplied node is the corosync node ID (with --last).
  • --tolerance=*SECONDS β€” (Advanced) do nothing if an equivalent --fence request succeeded less than this many seconds earlier (with --fence, --unfence, --reboot).

⭐ Application Options:

  • -$, --version β€” display software version and exit
  • -V, --verbose β€” increase debug output (may be specified multiple times)
  • -q, --quiet β€” be less descriptive in output.

🌈 AUTHOR 🌈

written by Andrew Beekhof and the Pacemaker project contributors. legends, fr fr 🫢


πŸ“ REPORTING BUGS πŸ“

found a bug? report it here, they actually want to hear it:

https://bugs.clusterlabs.org/enter_bug.cgi?product=Pacemaker

πŸ¦‹ random aside: some of these flags are marked (Advanced) and honestly that's your sign to read them twice before yeeting them into a production cluster. iykyk πŸ’…

and that's the page!! this whole thing is from Pacemaker 3.0.3+20260728.7052..., dated September 2026 β€” yes the version string is that long, she's got a lot going on πŸ’– mwah, go fence responsibly βœ¨πŸ‘‘

πŸ“¦ where this page comes from