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       -C, --separator=[char]
79              Separator for CSV created by 'list' operation (Default Value: ,)
80
81
82       --delay=[seconds]
83              Wait  X  seconds  before  fencing  is started (Default Value: 0)
84
85
86       --disable-timeout=[true/false]
87              Disable timeout (true/false) (default: true when run from  Pace‐
88              maker 2.0+)
89
90       --login-timeout=[seconds]
91              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
92
93
94       --power-timeout=[seconds]
95              Test X seconds for status change after  ON/OFF  (Default  Value:
96              20)
97
98       --power-wait=[seconds]
99              Wait X seconds after issuing ON/OFF (Default Value: 0)
100
101       --shell-timeout=[seconds]
102              Wait  X  seconds  for  cmd prompt after issuing command (Default
103              Value: 3)
104
105       --stonith-status-sleep=[seconds]
106              Sleep X seconds between status calls  during  a  STONITH  action
107              (Default Value: 1)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112       --telnet-path=[path]
113              Path to telnet binary (Default Value: /usr/bin/telnet)
114
115

ACTIONS

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

STDIN PARAMETERS

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