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
50              always 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
64              machine 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       --retry-on=[attempts]
126              Count of attempts to retry power on (Default Value: 1)
127
128       --ssh-path=[path]
129              Path to ssh binary (Default Value: /usr/bin/ssh)
130
131       --telnet-path=[path]
132              Path to telnet binary (Default Value: /usr/bin/telnet)
133
134

ACTIONS

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

STDIN PARAMETERS

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