FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

hii bestie 🫶 so this is a page from the System Manager's Manual, section 8, and it's about fence_heuristics_ping. yes the name is a mouthful. no we're not skipping any of it. let's go ✨

---

🌸 NAME 🌸

fence_heuristics_ping — the fence agent for ping-heuristic based fencing 💅

---

🦋 DESCRIPTION 🦋

so fence_heuristics_ping uses ping-heuristics to control execution of another fence agent that lives on the same fencing level. that's the whole vibe. that's the whole job. 🎀

🚨 not me being a real fence agent 🚨 — this is not a fence agent by itself! Its only purpose is to enable/disable another fence agent that lives on the same fencing level but after fence_heuristics_ping. so like, it's the opening act, not the headliner. 👑

The fence agent accepts options on the command line as well as from stdin. fenced sends parameters through stdin when it execs the agent. The agent can also be run by itself with command line options — which is lowkey useful for testing and for turning outlets on or off from scripts. slay. ✨

Vendor URL:

(yeah bestie, it's just... empty. that's the URL. it's giving mysterious. 💀)

---

✨ PARAMETERS ✨

• -o, --action=[action] — the fencing action you want to happen (Default Value: reboot)
• -m, --method=[method] — the method to fence, either onoff or cycle (Default Value: cycle)
• --ping-count=[number] — how many ping-probes get sent per target (Default Value: 10)
• --ping-good-count=[number] — how many positive ping-probes are required before we count a target as available (Default Value: 8)
• --ping-interval=[seconds] — the interval in seconds between ping-probes (Default Value: 1)
• --ping-maxfail=[number] — how many failed ping-targets we can have and still count the whole thing as an overall success (Default Value: 0)
• --ping-targets=tgt1,[inet6:]tgt2 — a comma separated list of ping-targets (optionally prepended by inet: or inet6:) that we're going to probe (Default Value: )
• --ping-timeout=[seconds] — the timeout in seconds until an individual ping-probe gets counted as lost (Default Value: 2)
• -q, --quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog. 💅
• -v, --verbose — verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack 'em like bracelets 🎀
• --verbose-level — level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• -D, --debug-file=[debugfile] — write debug information to given file
• -V, --version — display version information and exit
• -h, --help — display help and exit
• --plug-separator=[char] — separator for plug parameter when specifying more than 1 plug (Default Value: ,)
• --delay=[seconds] — wait X seconds before fencing is started (Default Value: 0)
• --disable-timeout=[true/false] — disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
• --login-timeout=[seconds] — wait X seconds for cmd prompt after login (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF (Default Value: 20)
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF (Default Value: 0)
• --shell-timeout=[seconds] — wait X seconds for cmd prompt after issuing command (Default Value: 3)
• --stonith-status-sleep=[seconds] — sleep X seconds between status calls during a STONITH action (Default Value: 1)
• --retry-on=[attempts] — count of attempts to retry power on (Default Value: 1)

---

🔥 ACTIONS 🔥

• on — power on machine. ⚡
• off — power off machine. 💀
• reboot — reboot machine. 🔄
• monitor — check the health of fence device 🩺
• metadata — display the XML metadata describing this resource.
• manpage — The operational behavior of this is not known. 😭 (yes fr, that's what it says, we don't make the rules)
• validate-all — validate if all required parameters are entered. ✅

---

🌈 STDIN PARAMETERS 🌈

• action — Fencing action (Default Value: reboot)
• method — Method to fence (onoff|cycle) (Default Value: cycle)
• ping_count — The number of ping-probes that is being sent per target (Default Value: 10)
• ping_good_count — The number of positive ping-probes required to account a target as available (Default Value: 8)
• ping_interval — The interval in seconds between ping-probes (Default Value: 1)
• ping_maxfail — The number of failed ping-targets to still account as overall success (Default Value: 0)
• ping_targets — A comma separated list of ping-targets (optionally prepended by inet: or inet6:) to be probed (Default Value: )
• ping_timeout — The timeout in seconds till an individual ping-probe is accounted as lost (Default Value: 2)
• quiet — Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
• verbose — Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
• verbose_level — Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• debug_file — Write debug information to given file Obsoletes: debug
• version — Display version information and exit
• help — Display help and exit
• plug_separator — Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
• delay — Wait X seconds before fencing is started (Default Value: 0)
• disable_timeout — Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
• login_timeout — Wait X seconds for cmd prompt after login (Default Value: 5)
• power_timeout — Test X seconds for status change after ON/OFF (Default Value: 20)
• power_wait — Wait X seconds after issuing ON/OFF (Default Value: 0)
• shell_timeout — Wait X seconds for cmd prompt after issuing command (Default Value: 3)
• stonith_status_sleep — Sleep X seconds between status calls during a STONITH action (Default Value: 1)
• retry_on — Count of attempts to retry power on (Default Value: 1)

---

okay bestie that's the whole page, no skips, no cuts, every flag accounted for 💖

this one came out of the Fence Agent source, dated 2009-10-20, and it lives on the FENCE_AGENT(8) page — yeah, a 2009 baddie still serving in section 8, we love a vintage icon 👑✨

periodt. now go ping something. 🦋