1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_brocade - Fence agent for HP Brocade over telnet/ssh
8

DESCRIPTION

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
22       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
27       Vendor URL: http://www.brocade.com
28

PARAMETERS

30
31
32       -o, --action=[action]
33              Fencing action (Default Value: off)
34
35       -c, --command-prompt=[prompt]
36              Force Python regex for command prompt (Default  Value:  ['>  '])
37
38
39       -k, --identity-file=[filename]
40              Identity file (private key) for SSH
41
42       -4, --inet4-only
43              Forces agent to use IPv4 addresses only
44
45       -6, --inet6-only
46              Forces agent to use IPv6 addresses only
47
48       -a, --ip=[ip]
49              IP  address  or hostname of fencing device This parameter is al‐
50              ways required.
51
52       -u, --ipport=[port]
53              TCP/UDP port to use for connection with device  (Default  Value:
54              23)
55
56       -p, --password=[password]
57              Login password or passphrase
58
59       -S, --password-script=[script]
60              Script to run to retrieve password
61
62       -n, --plug=[id]
63              Physical  plug  number  on device, UUID or identification of ma‐
64              chine This parameter is always required.
65
66       -x, --ssh
67              Use SSH connection
68
69       --ssh-options=[options]
70              SSH options to use
71
72       -l, --username=[name]
73              Login name This parameter is always required.
74
75       -q, --quiet
76              Disable logging to stderr. Does not affect --verbose or --debug-
77              file or logging to syslog.
78
79       -v, --verbose
80              Verbose  mode.  Multiple  -v flags can be stacked on the command
81              line (e.g., -vvv) to increase verbosity.
82
83       --verbose-level
84              Level of debugging detail in output. Defaults to the  number  of
85              --verbose  flags  specified on the command line, or to 1 if ver‐
86              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
87
88
89       -D, --debug-file=[debugfile]
90              Write debug information to given file
91
92       -V, --version
93              Display version information and exit
94
95       -h, --help
96              Display help and exit
97
98       --plug-separator=[char]
99              Separator  for  plug  parameter when specifying more than 1 plug
100              (Default Value: ,)
101
102       -C, --separator=[char]
103              Separator for CSV created by 'list' operation (Default Value: ,)
104
105
106       --delay=[seconds]
107              Wait  X  seconds  before  fencing  is started (Default Value: 0)
108
109
110       --disable-timeout=[true/false]
111              Disable timeout (true/false) (default: true when run from  Pace‐
112              maker 2.0+)
113
114       --login-timeout=[seconds]
115              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
116
117
118       --power-timeout=[seconds]
119              Test X seconds for status change after  ON/OFF  (Default  Value:
120              20)
121
122       --power-wait=[seconds]
123              Wait X seconds after issuing ON/OFF (Default Value: 0)
124
125       --shell-timeout=[seconds]
126              Wait  X  seconds  for  cmd prompt after issuing command (Default
127              Value: 3)
128
129       --stonith-status-sleep=[seconds]
130              Sleep X seconds between status calls  during  a  STONITH  action
131              (Default Value: 1)
132
133       --retry-on=[attempts]
134              Count of attempts to retry power on (Default Value: 1)
135
136       --ssh-path=[path]
137              Path to ssh binary (Default Value: /usr/bin/ssh)
138
139       --telnet-path=[path]
140              Path to telnet binary (Default Value: /usr/bin/telnet)
141
142

ACTIONS

144
145
146       on     Power on machine.
147
148       off    Power off machine.
149
150       status This returns the status of the plug/virtual machine.
151
152       list   List  available  plugs with aliases/virtual machines if there is
153              support for more then one device. Returns N/A otherwise.
154
155       list-status
156              List available plugs with  aliases/virtual  machines  and  their
157              power  state  if it can be obtained without additional commands.
158
159
160       monitor
161              Check the health of fence device
162
163       metadata
164              Display the XML metadata describing this resource.
165
166       manpage
167               The operational behavior of this is not known.
168
169       validate-all
170              Validate if all required parameters are entered.
171
172

STDIN PARAMETERS

174
175
176       action Fencing action (Default Value: off)
177
178       command_prompt
179              Force Python regex for command prompt (Default  Value:  ['>  '])
180              Obsoletes: cmd_prompt
181
182       identity_file
183              Identity file (private key) for SSH
184
185       inet4_only
186              Forces agent to use IPv4 addresses only
187
188       inet6_only
189              Forces agent to use IPv6 addresses only
190
191       ip     IP  address  or hostname of fencing device This parameter is al‐
192              ways required. Obsoletes: ipaddr
193
194       ipport TCP/UDP port to use for connection with device  (Default  Value:
195              23)
196
197       password
198              Login password or passphrase Obsoletes: passwd
199
200       password_script
201              Script  to  run  to  retrieve  password Obsoletes: passwd_script
202
203
204       plug   Physical plug number on device, UUID or  identification  of  ma‐
205              chine  This  parameter is always required. Obsoletes: port
206
207
208       ssh    Use SSH connection Obsoletes: secure
209
210       ssh_options
211              SSH options to use
212
213       username
214              Login name This parameter is always required.  Obsoletes:  login
215
216
217       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
218              file or logging to syslog.
219
220       verbose
221              Verbose mode. Multiple -v flags can be stacked  on  the  command
222              line (e.g., -vvv) to increase verbosity.
223
224       verbose_level
225              Level  of  debugging detail in output. Defaults to the number of
226              --verbose flags specified on the command line, or to 1  if  ver‐
227              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
228
229
230       debug_file
231              Write debug information to given file Obsoletes: debug
232
233       version
234              Display version information and exit
235
236       help   Display help and exit
237
238       plug_separator
239              Separator for plug parameter when specifying more  than  1  plug
240              (Default Value: ,)
241
242       separator
243              Separator for CSV created by 'list' operation (Default Value: ,)
244
245
246       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
247
248
249       disable_timeout
250              Disable  timeout (true/false) (default: true when run from Pace‐
251              maker 2.0+)
252
253       login_timeout
254              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
255
256
257       power_timeout
258              Test  X  seconds  for status change after ON/OFF (Default Value:
259              20)
260
261       power_wait
262              Wait X seconds after issuing ON/OFF (Default Value: 0)
263
264       shell_timeout
265              Wait X seconds for cmd prompt  after  issuing  command  (Default
266              Value: 3)
267
268       stonith_status_sleep
269              Sleep  X  seconds  between  status calls during a STONITH action
270              (Default Value: 1)
271
272       retry_on
273              Count of attempts to retry power on (Default Value: 1)
274
275       ssh_path
276              Path to ssh binary (Default Value: /usr/bin/ssh)
277
278       telnet_path
279              Path to telnet binary (Default Value: /usr/bin/telnet)
280
281
282
283fence_brocade (Fence Agent)       2009-10-20                    FENCE_AGENT(8)