1FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
3
7 fence_brocade - Fence agent for HP Brocade over telnet/ssh
8
10 fence_brocade is an I/O Fencing agent which can be used with Brocade FC
11 switches. It logs into a Brocade switch via telnet and disables a spec‐
12 ified port. Disabling the port which a machine is connected to effec‐
13 tively fences that machine. Lengthy telnet connections to the switch
14 should be avoided while a GFS cluster is running because the connec‐
15 tion will block any necessary fencing actions. After a fence operation
16 has taken place the fenced machine can no longer connect to the Brocade
17 FC switch. When the fenced machine is ready to be brought back into
18 the GFS cluster (after reboot) the port on the Brocade FC switch needs
19 to be enabled. This can be done by running fence_brocade and specifying
20 the enable action
21 fence_brocade accepts options on the command line as well as from
23 stdin. Fenced sends parameters through stdin when it execs the agent.
24 fence_brocade can be run by itself with command line options. This is
25 useful for testing and for turning outlets on or off from scripts.
26 Vendor URL: http://www.brocade.com
28
30 -o, --action=[action]
33 Fencing action (Default Value: off)
34 -c, --command-prompt=[prompt]
36 Force Python regex for command prompt (Default Value: ['> '])
37 -k, --identity-file=[filename]
40 Identity file (private key) for SSH
41 -4, --inet4-only
43 Forces agent to use IPv4 addresses only
44 -6, --inet6-only
46 Forces agent to use IPv6 addresses only
47 -a, --ip=[ip]
49 IP address or hostname of fencing device This parameter is
50 always required.
51 -u, --ipport=[port]
53 TCP/UDP port to use for connection with device (Default Value:
54 23)
55 -p, --password=[password]
57 Login password or passphrase
58 -S, --password-script=[script]
60 Script to run to retrieve password
61 -n, --plug=[id]
63 Physical plug number on device, UUID or identification of
64 machine This parameter is always required.
65 -x, --ssh
67 Use SSH connection
68 --ssh-options=[options]
70 SSH options to use
71 -l, --username=[name]
73 Login name This parameter is always required.
74 -q, --quiet
76 Disable logging to stderr. Does not affect --verbose or --debug-
77 file or logging to syslog.
78 -v, --verbose
80 Verbose mode
81 -D, --debug-file=[debugfile]
83 Write debug information to given file
84 -V, --version
86 Display version information and exit
87 -h, --help
89 Display help and exit
90 -C, --separator=[char]
92 Separator for CSV created by 'list' operation (Default Value: ,)
93 --delay=[seconds]
96 Wait X seconds before fencing is started (Default Value: 0)
97 --login-timeout=[seconds]
100 Wait X seconds for cmd prompt after login (Default Value: 5)
101 --power-timeout=[seconds]
104 Test X seconds for status change after ON/OFF (Default Value:
105 20)
106 --power-wait=[seconds]
108 Wait X seconds after issuing ON/OFF (Default Value: 0)
109 --shell-timeout=[seconds]
111 Wait X seconds for cmd prompt after issuing command (Default
112 Value: 3)
113 --retry-on=[attempts]
115 Count of attempts to retry power on (Default Value: 1)
116 --ssh-path=[path]
118 Path to ssh binary (Default Value: /usr/bin/ssh)
119 --telnet-path=[path]
121 Path to telnet binary (Default Value: /usr/bin/telnet)
122
125 on Power on machine.
128 off Power off machine.
130 status This returns the status of the plug/virtual machine.
132 list List available plugs with aliases/virtual machines if there is
134 support for more then one device. Returns N/A otherwise.
135 list-status
137 List available plugs with aliases/virtual machines and their
138 power state if it can be obtained without additional commands.
139 monitor
142 Check the health of fence device
143 metadata
145 Display the XML metadata describing this resource.
146 manpage
148 The operational behavior of this is not known.
149 validate-all
151 Validate if all required parameters are entered.
152
155 action Fencing action (Default Value: off)
158 command_prompt
160 Force Python regex for command prompt (Default Value: ['> '])
161 Obsoletes: cmd_prompt
162 identity_file
164 Identity file (private key) for SSH
165 inet4_only
167 Forces agent to use IPv4 addresses only
168 inet6_only
170 Forces agent to use IPv6 addresses only
171 ip IP address or hostname of fencing device This parameter is
173 always required. Obsoletes: ipaddr
174 ipport TCP/UDP port to use for connection with device (Default Value:
176 23)
177 password
179 Login password or passphrase Obsoletes: passwd
180 password_script
182 Script to run to retrieve password Obsoletes: passwd_script
183 plug Physical plug number on device, UUID or identification of
186 machine This parameter is always required. Obsoletes: port
187 ssh Use SSH connection Obsoletes: secure
190 ssh_options
192 SSH options to use
193 username
195 Login name This parameter is always required. Obsoletes: login
196 quiet Disable logging to stderr. Does not affect --verbose or --debug-
199 file or logging to syslog.
200 verbose
202 Verbose mode
203 debug_file
205 Write debug information to given file Obsoletes: debug
206 version
208 Display version information and exit
209 help Display help and exit
211 separator
213 Separator for CSV created by 'list' operation (Default Value: ,)
214 delay Wait X seconds before fencing is started (Default Value: 0)
217 login_timeout
220 Wait X seconds for cmd prompt after login (Default Value: 5)
221 power_timeout
224 Test X seconds for status change after ON/OFF (Default Value:
225 20)
226 power_wait
228 Wait X seconds after issuing ON/OFF (Default Value: 0)
229 shell_timeout
231 Wait X seconds for cmd prompt after issuing command (Default
232 Value: 3)
233 retry_on
235 Count of attempts to retry power on (Default Value: 1)
236 ssh_path
238 Path to ssh binary (Default Value: /usr/bin/ssh)
239 telnet_path
241 Path to telnet binary (Default Value: /usr/bin/telnet)
242fence_brocade (Fence Agent) 2009-10-20 FENCE_AGENT(8)