FENCE_AGENT(8)

πŸ“¦
version 4.17.0 Β· 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

fence_crosslink β€” bestie, it's the fence agent for cross-link two-node clusters πŸ’– (this lives in the FENCE_AGENT(8) manual, section 8, System Manager's Manual, iykyk)


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so picture this: you've got a two-node cluster and one node straight up lost power. it cannot be fenced the normal way, so this agent slides in and tells pacemaker the tea: if the node is not reachable over the crosslink cable, we can assume it is dead. main character energy, honestly. πŸ’…

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 be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: (it's just... blank bestie, nothing there πŸ™ˆ)


πŸŽ€ PARAMETERS πŸŽ€

  • -o, --action=[action] β€” the fencing action you want (Default Value: reboot)
  • -a, --crosscableip=[IP] β€” the Cross-cable IP. This parameter is always required. no skipping, fr fr
  • -n, --plug=[id] β€” Physical plug number on device, UUID or identification of machine. This parameter is always required. also non-negotiable
  • -T, --timeout=[seconds] β€” No ICMP reply in 5 seconds -> Node is considered dead (Default Value: 5) πŸ’€
  • -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. go off, stack em 🫢
  • --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: ,)
  • -C, --separator=[char] β€” Separator for CSV created by list operation (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. πŸ”„
  • status β€” This returns the status of the plug/virtual machine.
  • list β€” List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
  • list-status β€” List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
  • monitor β€” Check the health of fence device 🩺
  • metadata β€” Display the XML metadata describing this resource.
  • manpage β€” The operational behavior of this is not known. 😭 (not me putting a whole "we don't know" in here, but it's literally what it says)
  • validate-all β€” Validate if all required parameters are entered.

🌸 STDIN PARAMETERS 🌸

  • action β€” Fencing action (Default Value: reboot)
  • crosscableip β€” Cross-cable IP. This parameter is always required.
  • plug β€” Physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
  • timeout β€” No ICMP reply in 5 seconds -> Node is considered dead (Default Value: 5)
  • 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: ,)
  • separator β€” Separator for CSV created by list operation (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 and for the lil sign-off moment πŸŽ€βœ¨ this whole thing is fence_crosslink (Fence Agent), dated 2009-10-20, and it lives in FENCE_AGENT(8). slay. bye bestie, go fence something πŸ’–πŸ¦‹