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
36              always 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
50              machine 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       --retry-on=[attempts]
106              Count of attempts to retry power on (Default Value: 1)
107
108       --telnet-path=[path]
109              Path to telnet binary (Default Value: /usr/bin/telnet)
110
111

ACTIONS

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

STDIN PARAMETERS

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