FENCE_AGENT(8)

💖 FENCE_BROCADE — okay bestie, let's talk about fencing a Brocade switch 💖

so this page is FENCE_AGENT(8) from the System Manager's Manual, and the star of the show is fence_brocade — a Fence agent for HP Brocade over telnet/ssh. sit down, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

fence_brocade — Fence agent for HP Brocade over telnet/ssh 🦋

---

🌸 DESCRIPTION 🌸

okay so fence_brocade is an I/O Fencing agent that you use with Brocade FC switches. no cap. it logs into a Brocade switch via telnet and disables a specified port. and like… disabling the port that a machine is connected to effectively fences that machine. it's giving "you're not on the guest list anymore, periodt" 💅

⚠️ real talk, bestie: lengthy telnet connections to the switch should be avoided while a GFS cluster is running, because the connection will block any necessary fencing actions. not me warning you about blocking your own cluster 😭

after a fence operation has taken place, the fenced machine can no longer connect to the Brocade FC switch. and when the fenced machine is ready to be brought back into the GFS cluster (after reboot), the port on the Brocade FC switch needs to be enabled. you do that by running fence_brocade and specifying the enable action. slay ✨

the fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. the agent can be run by itself with command line options. this is useful for testing and for turning outlets on or off from scripts. lowkey handy.

Vendor URL: http://www.brocade.com 👑

---

🎀 PARAMETERS 🎀

here's the whole menu, no skips, no cuts:

• -o, --action=[action] — Fencing action (Default Value: off)
• -c, --command-prompt=[prompt] — Force Python regex for command prompt (Default Value: ['> '])
• -k, --identity-file=[filename] — Identity file (private key) for SSH
• -4, --inet4-only — Forces agent to use IPv4 addresses only
• -6, --inet6-only — Forces agent to use IPv6 addresses only
• -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: 23)
• -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. 👑
• -x, --ssh — Use SSH connection
• --ssh-options=[options] — SSH options to use
• -l, --username=[name] — Login name. This parameter is always required. 👑
• -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 ✨
• --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)
• --ssh-path=[path] — Path to ssh binary (Default Value: /usr/bin/ssh)
• --telnet-path=[path] — Path to telnet binary (Default Value: /usr/bin/telnet)

---

💅 ACTIONS 💅

the things you can ask it to do, and what they do:

• 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. 🙈 (fr fr, they said it, not me)
• validate-all — Validate if all required parameters are entered.

---

🫶 STDIN PARAMETERS 🫶

same energy, different spelling — these are the ones that come in through stdin. note the Obsoletes: tea ☕

• action — Fencing action (Default Value: off)
• command_prompt — Force Python regex for command prompt (Default Value: ['> ']) 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. This parameter is always required. 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 — Physical plug number on device, UUID or identification of machine. This parameter is always required. 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: ,)
• 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)
• ssh_path — Path to ssh binary (Default Value: /usr/bin/ssh)
• telnet_path — Path to telnet binary (Default Value: /usr/bin/telnet)

---

🌈 SEE ALSO 🌈

no SEE ALSO section on this page, bestie — that's the whole thing, and it ate. 💅

---

and that's a wrap! this was fence_brocade (Fence Agent), dated 2009-10-20, from the FENCE_AGENT(8) manual. iconic, timeless, still fenced. mwah 🎀✨💖