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       -C, --separator=[char]
99              Separator for CSV created by 'list' operation (Default Value: ,)
100
101
102       --delay=[seconds]
103              Wait X seconds before fencing  is  started  (Default  Value:  0)
104
105
106       --disable-timeout=[true/false]
107              Disable  timeout (true/false) (default: true when run from Pace‐
108              maker 2.0+)
109
110       --login-timeout=[seconds]
111              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
112
113
114       --power-timeout=[seconds]
115              Test  X  seconds  for status change after ON/OFF (Default Value:
116              20)
117
118       --power-wait=[seconds]
119              Wait X seconds after issuing ON/OFF (Default Value: 0)
120
121       --shell-timeout=[seconds]
122              Wait X seconds for cmd prompt  after  issuing  command  (Default
123              Value: 3)
124
125       --stonith-status-sleep=[seconds]
126              Sleep  X  seconds  between  status calls during a STONITH action
127              (Default Value: 1)
128
129       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132       --ssh-path=[path]
133              Path to ssh binary (Default Value: /usr/bin/ssh)
134
135       --telnet-path=[path]
136              Path to telnet binary (Default Value: /usr/bin/telnet)
137
138

ACTIONS

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

STDIN PARAMETERS

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