fence_brocade(8)

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 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 This parameter is always required.
50
51       -u, --ipport=[port]
52              TCP/UDP  port  to use for connection with device (Default Value:
53              23)
54
55       -l, --username=[name]
56              Login Name This parameter is always required.
57
58       -p, --password=[password]
59              Login password or passphrase
60
61       -S, --password-script=[script]
62              Script to retrieve password
63
64       -n, --plug=[id]
65              Physical plug number, name  of  virtual  machine  or  UUID  This
66              parameter is always required.
67
68       -x, --ssh
69              SSH connection
70
71       --ssh-options=[options]
72              SSH options to use
73
74       -v, --verbose
75              Verbose mode
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       -C, --separator=[char]
87              Separator  for  CSV created by operation list (Default Value: ,)
88
89
90       --delay=[seconds]
91              Wait X seconds before fencing  is  started  (Default  Value:  0)
92
93
94       --login-timeout=[seconds]
95              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
96
97
98       --power-timeout=[seconds]
99              Test X seconds for status change after  ON/OFF  (Default  Value:
100              20)
101
102       --power-wait=[seconds]
103              Wait X seconds after issuing ON/OFF (Default Value: 0)
104
105       --shell-timeout=[seconds]
106              Wait  X  seconds  for  cmd prompt after issuing command (Default
107              Value: 3)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112       --ssh-path=[path]
113              Path to ssh binary (Default Value: /usr/bin/ssh)
114
115       --telnet-path=[path]
116              Path to telnet binary (Default Value: /usr/bin/telnet)
117
118

ACTIONS

120
121
122       on     Power on machine.
123
124       off    Power off machine.
125
126       status This returns the status of the plug/virtual machine.
127
128       list   List available plugs with aliases/virtual machines if  there  is
129              support for more then one device. Returns N/A otherwise.
130
131       list-status
132              List  available  plugs  with  aliases/virtual machines and their
133              power state if it can be obtained without  additional  commands.
134
135
136       monitor
137              Check the health of fence device
138
139       metadata
140              Display the XML metadata describing this resource.
141
142

STDIN PARAMETERS

144
145
146       action Fencing Action (Default Value: off)
147
148       cmd_prompt
149              Force  Python  regex  for command prompt (Default Value: ['> '])
150
151
152       identity_file
153              Identity file for ssh
154
155       inet4_only
156              Forces agent to use IPv4 addresses only
157
158       inet6_only
159              Forces agent to use IPv6 addresses only
160
161       ipaddr IP Address or Hostname This parameter is always required.
162
163       ipport TCP/UDP port to use for connection with device  (Default  Value:
164              23)
165
166       login  Login Name This parameter is always required.
167
168       passwd Login password or passphrase
169
170       passwd_script
171              Script to retrieve password
172
173       port   Physical  plug  number,  name  of  virtual  machine or UUID This
174              parameter is always required.
175
176       secure SSH connection
177
178       ssh_options
179              SSH options to use
180
181       verbose
182              Verbose mode
183
184       debug  Write debug information to given file
185
186       version
187              Display version information and exit
188
189       help   Display help and exit
190
191       separator
192              Separator for CSV created by operation list (Default  Value:  ,)
193
194
195       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
196
197
198       login_timeout
199              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
200
201
202       power_timeout
203              Test  X  seconds  for status change after ON/OFF (Default Value:
204              20)
205
206       power_wait
207              Wait X seconds after issuing ON/OFF (Default Value: 0)
208
209       shell_timeout
210              Wait X seconds for cmd prompt  after  issuing  command  (Default
211              Value: 3)
212
213       retry_on
214              Count of attempts to retry power on (Default Value: 1)
215
216       ssh_path
217              Path to ssh binary (Default Value: /usr/bin/ssh)
218
219       telnet_path
220              Path to telnet binary (Default Value: /usr/bin/telnet)
221
222
223
224fence_brocade (Fence Agent)       2009-10-20                    FENCE_AGENT(8)