FENCE_AGENT(8)

✨ NAME ✨

fence_ifmib — the fence agent for IF MIB, and yes she's that girl 💅

---

🦋 DESCRIPTION 🦋

Okay so bestie, listen. fence_ifmib is an I/O Fencing agent, and she works with literally any SNMP IF-MIB capable device. No cap.

She was written with managed ethernet switches in mind, because the whole point is fencing iSCSI SAN connections. But the way that so many devices out there support the IF-MIB interface… it's giving versatility. The agent uses IF-MIB::ifAdminStatus to control the state of an interface. That's the whole vibe. 🎀

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. But you can also just run the agent by itself with command line options — which is lowkey so useful for testing, and for turning outlets on or off from scripts. Iconic behavior honestly. ✨

Vendor URL: http://www.ietf.org/wg/concluded/ifmib.html

---

🌸 PARAMETERS 🌸

Every flag you could ever need, mwah 🫶

• -o, --action=[action] — the fencing action you want to happen. (Default Value: off)
• -c, --community=[community] — set the community string.
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. Like, always.
• -u, --ipport=[port] — the TCP/UDP port to use for connecting to the device. (Default Value: 161)
• -p, --password=[password] — login password or passphrase.
• -S, --password-script=[script] — a script to run to retrieve the password.
• -n, --plug=[id] — physical plug number on the device, or the UUID, or the identification of the machine. This parameter is always required.
• -b, --snmp-auth-prot=[prot] — set the authentication protocol (MD5|SHA).
• -P, --snmp-priv-passwd=[pass] — set the privacy protocol password.
• -R, --snmp-priv-passwd-script — script to run to retrieve the privacy password.
• -B, --snmp-priv-prot=[prot] — set the privacy protocol (DES|AES).
• -E, --snmp-sec-level=[level] — set the security level (noAuthNoPriv|authNoPriv|authPriv).
• -d, --snmp-version=[version] — specifies which SNMP version to use (1|2c|3). (Default Value: 2c)
• -l, --username=[name] — login name.
• -q, --quiet — disable logging to stderr. Doesn't affect --verbose, --debug-file, or logging to syslog, jsyk.
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (e.g., -vvv) to increase verbosity. Go off. 🔥
• --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: ,)
• -C, --separator=[char] — the 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)
• --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] — count of attempts to retry power on. (Default Value: 1)
• --snmpget-path=[path] — path to the snmpget binary. (Default Value: /usr/bin/snmpget)
• --snmpset-path=[path] — path to the snmpset binary. (Default Value: /usr/bin/snmpset)
• --snmpwalk-path=[path] — path to the snmpwalk binary. (Default Value: /usr/bin/snmpwalk)

---

👑 ACTIONS 👑

• on — power on the machine. ⚡
• off — power off 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. Efficiency queen 💅
• 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. 😭 (not me being honest about it)
• validate-all — validate if all required parameters are entered.

---

🧚 STDIN PARAMETERS 🧚

Same energy, different delivery system — these come in through stdin. Fenced knows what's up.

• action — fencing action. (Default Value: off)
• community — set the community string.
• 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: 161)
• 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
• snmp_auth_prot — set authentication protocol (MD5|SHA).
• snmp_priv_passwd — set privacy protocol password.
• snmp_priv_passwd_script — script to run to retrieve privacy password.
• snmp_priv_prot — set privacy protocol (DES|AES).
• snmp_sec_level — set security level (noAuthNoPriv|authNoPriv|authPriv).
• snmp_version — specifies SNMP version to use (1|2c|3). (Default Value: 2c)
• username — login name. 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: ,)
• 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)
• snmpget_path — path to snmpget binary. (Default Value: /usr/bin/snmpget)
• snmpset_path — path to snmpset binary. (Default Value: /usr/bin/snmpset)
• snmpwalk_path — path to snmpwalk binary. (Default Value: /usr/bin/snmpwalk)

---

This page is fence_ifmib (Fence Agent), dated 2009-10-20, and it lives in section FENCE_AGENT(8) of the System Manager's Manual. That's the whole rundown bestie, go fence something responsibly 💖✨🦋