FENCE_AGENT(8)

💖 fence_cisco_mds — a Gen Z field guide 💖

okay bestie, pull up a chair 🫶 this is fence_cisco_mds(8), part of the System Manager's Manual (that's the fence_cisco_mds manual page, section 8 — system administration tools, iykyk). it's an I/O fencing agent, which sounds scary but is really just "the thing that yanks power from a misbehaving machine so the cluster doesn't have a meltdown." slay. 💅

---

✨ NAME ✨

fence_cisco_mds — Fence agent for Cisco MDS. no cap, that's the whole name. 🌸

---

🦋 DESCRIPTION 🦋

okay so fence_cisco_mds is an I/O Fencing agent and it works with any Cisco MDS 9000 series device that has SNMP enabled. any of them. the whole squad. 👑

the fence agent accepts options on the command line and from stdin. here's the tea: 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. main character energy for a daemon, honestly. ✨

Vendor URL: http://www.cisco.com — go say hi to them, not me. 🫶

---

🎀 PARAMETERS 🎀

here's the full lineup, every single one, no skips, no cuts. periodt.

• -o, --action=[action] — Fencing action (Default Value: off)
• -c, --community=[community] — Set the community string
• -a, --ip=[ip] — IP address or hostname of fencing device. This parameter is always required.
• -u, --ipport=[port] — TCP/UDP port to use for connection with device (Default Value: 161)
• -p, --password=[password] — Login password or passphrase
• -S, --password-script=[script] — Script to run to retrieve password
• -n, --plug=[id] — Physical plug number on device, UUID or identification of machine. This parameter is always required.
• -b, --snmp-auth-prot=[prot] — Set authentication protocol (MD5|SHA)
• -P, --snmp-priv-passwd=[pass] — Set privacy protocol password
• -R, --snmp-priv-passwd-script — Script to run to retrieve privacy password
• -B, --snmp-priv-prot=[prot] — Set privacy protocol (DES|AES)
• -E, --snmp-sec-level=[level] — Set security level (noAuthNoPriv|authNoPriv|authPriv)
• -d, --snmp-version=[version] — Specifies SNMP version to use (1|2c|3)
• -l, --username=[name] — Login name
• -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. stack 'em like bracelets bestie ✨
• --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)
• --snmpget-path=[path] — Path to snmpget binary (Default Value: /usr/bin/snmpget)
• --snmpset-path=[path] — Path to snmpset binary (Default Value: /usr/bin/snmpset)
• --snmpwalk-path=[path] — Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)

---

🔥 ACTIONS 🔥

the things this agent can actually do. the résumé. 💅

• on — Power on machine. ⚡
• off — Power off 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 then 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 fence device 🩺
• metadata — Display the XML metadata describing this resource.
• manpage — The operational behavior of this is not known. (ngl, iconic that they just admitted it 🙈)
• validate-all — Validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

so when fenced execs the agent, this is what comes down the pipe. same crew, snake_case names this time. 🐍

• 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)
• 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)

---

heads up bestie: ip and plug are always required. no ip, no plug, no fencing. it's giving non-negotiable. 🚨

---

and that's the whole page!! 🎀 this was fence_cisco_mds (Fence Agent), dated 2009-10-20 — yeah, she's an elder but she still eats. mwah, go fence something responsibly. 💜✨🦋