FENCE_AGENT(8)

πŸ“¦
version 4.17.0 Β· 4 versions
, in centos-stream 10, debian trixie, fedora 43, fedora 44, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ FENCE_AGENT(8) β€” the girlies' guide to fencing HP servers ✨

System Manager's Manual energy, bestie. This is FENCE_AGENT(8) and we're gonna make it make sense. πŸ’–


πŸŽ€ NAME

fence_ilo β€” the fence agent for HP iLO. And fence_ilo2 β€” the fence agent for HP iLO2, which is literally just a symlink. Same girl, different name. πŸ’…


🌸 DESCRIPTION

So fence_ilo2 is a Power Fencing agent for HP servers that have the Integrated Light Out (iLO) PCI card. The way it works? The agent opens an SSL connection to the iLO card. Once that SSL connection is up and running, the agent can talk to the iLO card through an XML stream. No cap. πŸ¦‹

Also, this fence agent takes options on the command line and from stdin. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent all by itself with command line options β€” which is lowkey so useful for testing and for turning outlets on or off from scripts. ✨

Vendor URL: http://www.hp.com πŸ‘‘


πŸ’œ PARAMETERS

Every flag, every default, all of it. Don't skip a single one, bestie. πŸ™ˆ

  • -o, --action=[action] β€” what fencing action we're doing (Default Value: reboot)
  • -a, --ip=[ip] β€” IP address or hostname of the fencing device
  • -u, --ipport=[port] β€” the TCP/UDP port we use to connect to the device (Default Value: 443)
  • -t, --notls β€” disables TLS negotiation and forces SSL3.0. Only use this for devices that don't support TLS1.0 and up, okay??
  • -p, --password=[password] β€” login password or passphrase
  • -S, --password-script=[script] β€” script to run to go get that password
  • -n, --plug=[ip] β€” IP address or hostname of the fencing device (this goes together with --port-as-ip)
  • -r, --ribcl-version=[version] β€” force which ribcl version to use
  • -z, --ssl β€” use an SSL connection with certificate verifying (Default Value: 1)
  • --ssl-insecure β€” use an SSL connection without verifying the certificate
  • --ssl-secure β€” use an SSL connection with verifying the certificate
  • --tls1.0 β€” disables TLS negotiation and forces TLS1.0. Only for devices that don't support TLS1.1 and up!
  • -l, --username=[name] β€” login name. This parameter is always required. Periodt.
  • -q, --quiet β€” turns off logging to stderr. Does not affect --verbose, --debug-file, or logging to syslog.
  • -v, --verbose β€” verbose mode. You can stack multiple -v flags on the command line (like -vvv) to crank up the verbosity. 🎚️
  • --verbose-level β€” how much debugging detail shows up in output. Defaults to the number of --verbose flags you gave 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 info to the given file
  • -V, --version β€” show version info and exit
  • -h, --help β€” show help and exit
  • --plug-separator=[char] β€” the separator for the plug parameter when you're specifying more than 1 plug (Default Value: ,)
  • --delay=[seconds] β€” wait X seconds before fencing even starts (Default Value: 0)
  • --disable-timeout=[true/false] β€” disable timeout, true or false (default: true when run from Pacemaker 2.0+)
  • --login-timeout=[seconds] β€” wait X seconds for the cmd prompt after login (Default Value: 10)
  • --port-as-ip β€” makes "port/plug" an alias to the IP address
  • --power-timeout=[seconds] β€” test X seconds for a 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 the cmd prompt after issuing a command (Default Value: 3)
  • --stonith-status-sleep=[seconds] β€” sleep X seconds between status calls during a STONITH action (Default Value: 1)
  • --retry-on=[attempts] β€” how many attempts to retry power on (Default Value: 3)
  • --gnutlscli-path=[path] β€” path to the gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

πŸ”₯ ACTIONS

  • on β€” power on the machine πŸ’‘
  • off β€” power off the machine
  • reboot β€” reboot the machine πŸ”„
  • status β€” returns the status of the plug/virtual machine
  • monitor β€” check the health of the fence device 🩺
  • metadata β€” display the XML metadata describing this resource
  • manpage β€” ngl, the operational behavior of this one is not known πŸ’€
  • validate-all β€” validate that all required parameters are entered

🌈 STDIN PARAMETERS

Same vibes, underscore names, and some of them have Obsoletes β€” meaning the old name still hangs around like an ex. 😭

  • action β€” fencing action (Default Value: reboot)
  • ip β€” IP address or hostname of fencing device. Obsoletes: ipaddr
  • ipport β€” TCP/UDP port to use for connection with device (Default Value: 443)
  • notls β€” disable TLS negotiation and force SSL3.0. Only for devices that don't support TLS1.0 and up.
  • password β€” login password or passphrase. Obsoletes: passwd
  • password_script β€” script to run to retrieve password. Obsoletes: passwd_script
  • plug β€” IP address or hostname of fencing device (together with --port-as-ip). Obsoletes: port
  • ribcl_version β€” force ribcl version to use. Obsoletes: ribcl
  • ssl β€” use SSL connection with verifying certificate (Default Value: 1)
  • ssl_insecure β€” use SSL connection without verifying certificate
  • ssl_secure β€” use SSL connection with verifying certificate
  • tls1.0 β€” disable TLS negotiation and force TLS1.0. Only for devices that don't support TLS1.1 and up.
  • username β€” login name. This parameter is always required. Obsoletes: login
  • 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: 10)
  • port_as_ip β€” make "port/plug" to be an alias to IP address
  • 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: 3)
  • gnutlscli_path β€” path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

🫢 That's the whole page, bestie. Every flag, every default, every obsoleted name β€” nothing got left behind. Slay.

This one's a fence_ilo (Fence Agent) situation, dated 2009-10-20, and it's page FENCE_AGENT(8) of your system manager's manual. Byeee, go fence something responsibly πŸ’–βœ¨

πŸ“¦ where this page comes from