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) πŸ’–

okay bestie, sit DOWN, because today we're talking about fence_ilo_mp β€” straight out of the System Manager's Manual, section 8, and honestly? she's giving infrastructure royalty. πŸ‘‘


✨ NAME ✨

fence_ilo_mp β€” the fence agent for HP iLO MP, no cap. πŸ¦‹


🌸 DESCRIPTION 🌸

So, fence_ilo_mp is a Power Fencing agent for HP iLO MP. That's the whole vibe. πŸ’…

Here's the tea: this agent is not picky about where it gets its options from β€” it'll take them on the command line or from stdin, either one, she's flexible like that. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent by itself with command line options, which is lowkey perfect for testing and for turning outlets on or off from scripts. Like, go off, honestly. πŸ”₯

Vendor URL: http://www.hp.com


πŸŽ€ PARAMETERS πŸŽ€

Every single flag, bestie. Not skipping a single one, that would be a crime.

  • -o, --action=[action] β€” the fencing action. (Default Value: reboot)
  • -c, --command-prompt=[prompt] β€” force a Python regex for the command prompt. (Default Value: ['MP>', 'hpiLO->'])
  • -k, --identity-file=[filename] β€” the identity file (private key) for SSH. πŸ”‘
  • -4, --inet4-only β€” forces the agent to use IPv4 addresses only.
  • -6, --inet6-only β€” forces the agent to use IPv6 addresses only.
  • -a, --ip=[ip] β€” IP address or hostname of the fencing device.
  • -u, --ipport=[port] β€” TCP/UDP port to use for the connection with the device. (Default Value: 23)
  • -p, --password=[password] β€” login password or passphrase.
  • -S, --password-script=[script] β€” script to run to retrieve the password.
  • -n, --plug=[ip] β€” IP address or hostname of the fencing device (this one goes together with --port-as-ip).
  • -x, --ssh β€” use an SSH connection. ✨
  • --ssh-options=[options] β€” SSH options to use.
  • -l, --username=[name] β€” login name. This parameter is always required. Like, always. Don't forget her. 😭
  • -q, --quiet β€” disable logging to stderr. Heads up though: it does not affect --verbose, or --debug-file, or logging to syslog.
  • -v, --verbose β€” verbose mode. You can stack multiple -v flags on the command line (e.g. -vvv) to increase verbosity. Go feral with it. πŸ—£οΈ
  • --verbose-level β€” level of debugging detail in the 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 the given file.
  • -V, --version β€” display version information and exit.
  • -h, --help β€” display 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 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 the cmd prompt after login. (Default Value: 5)
  • --port-as-ip β€” makes "port/plug" be an alias to the IP address.
  • --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: 5)
  • --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] β€” count of attempts to retry power on. (Default Value: 1)
  • --ssh-path=[path] β€” path to the ssh binary. (Default Value: /usr/bin/ssh)
  • --telnet-path=[path] β€” path to the telnet binary. (Default Value: /usr/bin/telnet)

πŸ”₯ ACTIONS πŸ”₯

the things she can actually DO, periodt.

  • on β€” power on machine.
  • off β€” power off machine.
  • reboot β€” reboot machine.
  • status β€” this 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 β€” the operational behavior of this is not known. (iykyk, we genuinely don't know, that's literally what it says πŸ’€)
  • validate-all β€” validate if all required parameters are entered.

🌈 STDIN PARAMETERS 🌈

same energy, but the names use underscores because stdin said "no dashes, we're not doing that."

  • action β€” fencing action (Default Value: reboot)
  • command_prompt β€” force Python regex for command prompt (Default Value: ['MP>', 'hpiLO->']) Obsoletes: cmd_prompt
  • identity_file β€” identity file (private key) for SSH
  • inet4_only β€” forces agent to use IPv4 addresses only
  • inet6_only β€” forces agent to use IPv6 addresses only
  • ip β€” IP address or hostname of fencing device Obsoletes: ipaddr
  • ipport β€” TCP/UDP port to use for connection with device (Default Value: 23)
  • 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
  • ssh β€” use SSH connection Obsoletes: secure
  • ssh_options β€” SSH options to use
  • 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: 5)
  • 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: 5)
  • 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)
  • ssh_path β€” path to ssh binary (Default Value: /usr/bin/ssh)
  • telnet_path β€” path to telnet binary (Default Value: /usr/bin/telnet)

πŸ’€ bestie reminder: that manpage action's behavior is not known, and --username / username is always required. Read the fine print, she's not joking.

and that's the whole page!! mwah πŸ’‹ this was fence_ilo_mp (Fence Agent), dated 2009-10-20, living in the FENCE_AGENT(8) manual β€” a true vintage icon and she still ate. πŸŽ€βœ¨ bye bestie, go fence something responsibly 🫢

πŸ“¦ where this page comes from