FENCE_AGENT(8)

FENCE_AGENT(8) — fence_docker 🐳✨

okay so bestie, this is a page from the System Manager's Manual, section 8, and it's all about fence_docker 💖 (that's the NAME, btw — a fence agent for Docker, periodt).

---

🌸 NAME 🌸

fence_docker — Fence agent for Docker 🐳

---

✨ DESCRIPTION ✨

fence_docker is a Power Fencing agent that you can use with Docker Engine containers. The way this works is: you can run this fence-agent with zero authentication, like, none at all, or you can go the TLS route and use TLS authentication (that's the --ssl option, and if you want the deets on TLS auth in docker it's literally right here: http://docs.docker.com/examples/https/). 💅

So the fence agent is flexible like that — it accepts options on the command line and from stdin. Fenced sends parameters through stdin when it execs the agent. And the agent can also just be run by itself with command line options, which is lowkey so useful for testing and for turning outlets on or off from scripts. 🔥

Vendor URL: www.docker.io — go say hi 🌈

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required, no exceptions bestie 💀
• -u, --ipport=[port] — the TCP/UDP port to use for the connection with the device (Default Value: 443)
• -m, --method=[method] — the method to fence (onoff|cycle) (Default Value: onoff)
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. This parameter is always required too 🫶
• -z, --ssl — use an SSL connection with verifying certificate (Default Value: 1)
• --ssl-insecure — use an SSL connection without verifying certificate 🙈
• --ssl-secure — use an SSL connection with verifying certificate
• --api-version — version of Docker Remote API (default: 1.11) (Default Value: 1.11)
• --disable-ssl — don't use SSL
• --tlscacert — path to CA certificate (PEM format) for TLS authentication. Required if --ssl option is used.
• --tlscert — path to client certificate (PEM format) for TLS authentication. Required if --ssl option is used.
• --tlskey — path to client key (PEM format) for TLS authentication. Required if --ssl option is used.
• --unix-socket — path to Docker's unix socket. Use this one with --disable-ssl.
• -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 👑
• --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)
• --gnutlscli-path=[path] — path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

💜 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 than 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 the fence device 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. 💀 (yeah, they said that, not me)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• action — fencing action (Default Value: reboot)
• ip — IP address or hostname of fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 443)
• method — method to fence (onoff|cycle) (Default Value: onoff)
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• 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
• api_version — version of Docker Remote API (default: 1.11) (Default Value: 1.11)
• disable_ssl — don't use SSL
• tlscacert — path to CA certificate (PEM format) for TLS authentication. Required if --ssl option is used.
• tlscert — path to client certificate (PEM format) for TLS authentication. Required if --ssl option is used.
• tlskey — path to client key (PEM format) for TLS authentication. Required if --ssl option is used.
• unix_socket — path to Docker's unix socket. Use this with --disable-ssl.
• 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)
• gnutlscli_path — path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

and that's the whole vibe check, bestie — this page is fence_docker (Fence Agent) and it's dated 2009-10-20, living its best life as part of FENCE_AGENT(8). go forth and fence responsibly 💖✨🐳