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

NAME

7       fence_sanbox2 - Fence agent for QLogic SANBox2 FC switches
8

DESCRIPTION

10       fence_sanbox2  is  an  I/O  Fencing agent which can be used with QLogic
11       SANBox2 FC switches.  It logs into a SANBox2 switch via telnet and dis‐
12       ables  a  specified  port.  Disabling  the port which a machine is con‐
13       nected to effectively fences that machine. Lengthy  telnet  connections
14       to  the switch should be avoided while a GFS cluster is running because
15       the connection will block any necessary fencing actions.
16
17       fence_sanbox2 accepts options on the  command  line  as  well  as  from
18       stdin.  Fenced  sends parameters through stdin when it execs the agent.
19       fence_sanbox2 can be run by itself with command line options.  This  is
20       useful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: http://www.qlogic.com
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: off)
29
30       -c, --command-prompt=[prompt]
31              Force  Python regex for command prompt (Default Value: [' #> '])
32
33
34       -a, --ip=[ip]
35              IP address or hostname of fencing device This parameter  is  al‐
36              ways required.
37
38       -u, --ipport=[port]
39              TCP/UDP  port  to use for connection with device (Default Value:
40              23)
41
42       -p, --password=[password]
43              Login password or passphrase
44
45       -S, --password-script=[script]
46              Script to run to retrieve password
47
48       -n, --plug=[id]
49              Physical plug number on device, UUID or  identification  of  ma‐
50              chine This parameter is always required.
51
52       -l, --username=[name]
53              Login name This parameter is always required.
54
55       -q, --quiet
56              Disable logging to stderr. Does not affect --verbose or --debug-
57              file or logging to syslog.
58
59       -v, --verbose
60              Verbose mode. Multiple -v flags can be stacked  on  the  command
61              line (e.g., -vvv) to increase verbosity.
62
63       --verbose-level
64              Level  of  debugging detail in output. Defaults to the number of
65              --verbose flags specified on the command line, or to 1  if  ver‐
66              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
67
68
69       -D, --debug-file=[debugfile]
70              Write debug information to given file
71
72       -V, --version
73              Display version information and exit
74
75       -h, --help
76              Display help and exit
77
78       --plug-separator=[char]
79              Separator for plug parameter when specifying more  than  1  plug
80              (Default Value: ,)
81
82       -C, --separator=[char]
83              Separator for CSV created by 'list' operation (Default Value: ,)
84
85
86       --delay=[seconds]
87              Wait X seconds before fencing  is  started  (Default  Value:  0)
88
89
90       --disable-timeout=[true/false]
91              Disable  timeout (true/false) (default: true when run from Pace‐
92              maker 2.0+)
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       --stonith-status-sleep=[seconds]
110              Sleep  X  seconds  between  status calls during a STONITH action
111              (Default Value: 1)
112
113       --retry-on=[attempts]
114              Count of attempts to retry power on (Default Value: 1)
115
116       --telnet-path=[path]
117              Path to telnet binary (Default Value: /usr/bin/telnet)
118
119

ACTIONS

121
122
123       on     Power on machine.
124
125       off    Power off machine.
126
127       status This returns the status of the plug/virtual machine.
128
129       list   List available plugs with aliases/virtual machines if  there  is
130              support for more then one device. Returns N/A otherwise.
131
132       list-status
133              List  available  plugs  with  aliases/virtual machines and their
134              power state if it can be obtained without  additional  commands.
135
136
137       monitor
138              Check the health of fence device
139
140       metadata
141              Display the XML metadata describing this resource.
142
143       manpage
144               The operational behavior of this is not known.
145
146       validate-all
147              Validate if all required parameters are entered.
148
149

STDIN PARAMETERS

151
152
153       action Fencing action (Default Value: off)
154
155       command_prompt
156              Force  Python regex for command prompt (Default Value: [' #> '])
157              Obsoletes: cmd_prompt
158
159       ip     IP address or hostname of fencing device This parameter  is  al‐
160              ways required. Obsoletes: ipaddr
161
162       ipport TCP/UDP  port  to use for connection with device (Default Value:
163              23)
164
165       password
166              Login password or passphrase Obsoletes: passwd
167
168       password_script
169              Script to run  to  retrieve  password  Obsoletes:  passwd_script
170
171
172       plug   Physical  plug  number  on device, UUID or identification of ma‐
173              chine This parameter is always required. Obsoletes:  port
174
175
176       username
177              Login  name  This parameter is always required. Obsoletes: login
178
179
180       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
181              file or logging to syslog.
182
183       verbose
184              Verbose  mode.  Multiple  -v flags can be stacked on the command
185              line (e.g., -vvv) to increase verbosity.
186
187       verbose_level
188              Level of debugging detail in output. Defaults to the  number  of
189              --verbose  flags  specified on the command line, or to 1 if ver‐
190              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
191
192
193       debug_file
194              Write debug information to given file Obsoletes: debug
195
196       version
197              Display version information and exit
198
199       help   Display help and exit
200
201       plug_separator
202              Separator  for  plug  parameter when specifying more than 1 plug
203              (Default Value: ,)
204
205       separator
206              Separator for CSV created by 'list' operation (Default Value: ,)
207
208
209       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
210
211
212       disable_timeout
213              Disable timeout (true/false) (default: true when run from  Pace‐
214              maker 2.0+)
215
216       login_timeout
217              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
218
219
220       power_timeout
221              Test X seconds for status change after  ON/OFF  (Default  Value:
222              20)
223
224       power_wait
225              Wait X seconds after issuing ON/OFF (Default Value: 0)
226
227       shell_timeout
228              Wait  X  seconds  for  cmd prompt after issuing command (Default
229              Value: 3)
230
231       stonith_status_sleep
232              Sleep X seconds between status calls  during  a  STONITH  action
233              (Default Value: 1)
234
235       retry_on
236              Count of attempts to retry power on (Default Value: 1)
237
238       telnet_path
239              Path to telnet binary (Default Value: /usr/bin/telnet)
240
241
242
243fence_sanbox2 (Fence Agent)       2009-10-20                    FENCE_AGENT(8)