FENCE_AGENT(8)

💖 NAME 💖

fence_zvmip — the fence agent bestie for z/VM Virtual Machines 🧚

---

✨ DESCRIPTION ✨

okay so, fence_zvmip is a Power Fencing agent for the z/VM SMAPI service, and it talks to it over TCP/IP. periodt.

Now here's the part where you actually have to do homework, sorry 😭 — the z/VM SMAPI service has to be set up so that the virtual machine running this agent can:

• connect to the service,
• access the system's directory manager,
• and then, like, shortly after that, run image_deactivate and image_activate.

Which means updating the VSMWORK1 NAMELIST and VSMWORK1 AUTHLIST VMSYS:VSMWORK1 files. no cap.

The NAMELIST entry gives all the required functions to one nick, and it should look something like this:

:nick.ZVM_FENCE
:list.
IMAGE_ACTIVATE
IMAGE_DEACTIVATE
IMAGE_STATUS_QUERY
CHECK_AUTHENTICATION
IMAGE_NAME_QUERY_DM

The AUTHLIST entry authorizes the user to do all the functions tied to that nick, and it should look something like this:

Column 1                   Column 66                Column 131

|                          |                        |
V                          V                        V

XXXXXXXX                   ALL                      ZVM_FENCE

where XXXXXXXX is the name of the user in the authuser field of the request. 💅

Refer to the official z/VM documentation for complete instructions and reference materials — that's the real tea, fr fr.

The fence agent accepts options on the command line and from stdin. Fenced sends parameters through stdin when it execs the agent. The agent can also be run by itself with command line options. That's lowkey so useful for testing and for turning outlets on or off from scripts. 🫶

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

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -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. This parameter is always required.
• -u, --ipport=[port] — the TCP/UDP port to use when connecting to the device (Default Value: 44444)
• -m, --method=[method] — method to fence (onoff|cycle) (Default Value: onoff)
• -p, --password=[password] — login password or passphrase
• -S, --password-script=[script] — script to run to retrieve the password
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. This parameter is always required.
• -z, --ssl — use an SSL connection with verifying certificate (Default) (Default Value: 1)
• --ssl-insecure — use an SSL connection without verifying the certificate
• --ssl-secure — use an SSL connection with verifying the certificate
• -l, --username=[name] — login name. This parameter is always required.
• --disable-ssl — don't use 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 the given file
• -V, --version — display version information and exit
• -h, --help — display help and exit
• --plug-separator=[char] — separator for the plug parameter when you're specifying more than 1 plug (Default Value: ,)
• -C, --separator=[char] — separator for the CSV created by the 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 the cmd prompt after login (Default Value: 5)
• --missing-as-off — a missing port returns OFF instead of failure (Default Value: 1)
• --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: 5)
• --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 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 — this returns the status of the plug/virtual machine.
• list — list available plugs with aliases/virtual machines if there's 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. 🙈
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• action — fencing action (Default Value: reboot)
• inet4_only — forces the agent to use IPv4 addresses only
• inet6_only — forces the agent to use IPv6 addresses only
• 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: 44444)
• method — method to fence (onoff|cycle) (Default Value: onoff)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• 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) (Default Value: 1)
• ssl_insecure — use SSL connection without verifying certificate
• ssl_secure — use SSL connection with verifying certificate
• username — login name. This parameter is always required. Obsoletes: login
• disable_ssl — don't use 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)
• missing_as_off — missing port returns OFF instead of failure (Default Value: 1)
• 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: 5)
• 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 page, bestie 💜 this one's fence_zvmip (Fence Agent), from way back on 2009-10-20, and it lives in the System Manager's Manual section as page FENCE_AGENT(8). slay, go fence something responsibly 👑🌸