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

NAME

7       fence_ifmib - Fence agent for IF MIB
8

DESCRIPTION

10       fence_ifmib is an I/O Fencing agent which can be used with any SNMP IF-
11       MIB capable device.
12
13       It was written with managed ethernet switches  in  mind,  in  order  to
14       fence  iSCSI SAN connections. However, there are many devices that sup‐
15       port the IF-MIB interface. The agent uses IF-MIB::ifAdminStatus to con‐
16       trol the state of an interface.
17
18       fence_ifmib  accepts options on the command line as well as from stdin.
19       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
20       fence_ifmib  can  be  run by itself with command line options.  This is
21       useful for testing and for turning outlets on or off from scripts.
22
23       Vendor URL: http://www.ietf.org/wg/concluded/ifmib.html
24

PARAMETERS

26
27
28       -o, --action=[action]
29              Fencing action (Default Value: off)
30
31       -c, --community=[community]
32              Set the community string
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              161)
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       -b, --snmp-auth-prot=[prot]
53              Set authentication protocol (MD5|SHA)
54
55       -P, --snmp-priv-passwd=[pass]
56              Set privacy protocol password
57
58       -R, --snmp-priv-passwd-script
59              Script to run to retrieve privacy password
60
61       -B, --snmp-priv-prot=[prot]
62              Set privacy protocol (DES|AES)
63
64       -E, --snmp-sec-level=[level]
65              Set security level (noAuthNoPriv|authNoPriv|authPriv)
66
67       -d, --snmp-version=[version]
68              Specifies SNMP version to use (1|2c|3) (Default Value: 2c)
69
70       -l, --username=[name]
71              Login name
72
73       -q, --quiet
74              Disable logging to stderr. Does not affect --verbose or --debug-
75              file or logging to syslog.
76
77       -v, --verbose
78              Verbose mode. Multiple -v flags can be stacked  on  the  command
79              line (e.g., -vvv) to increase verbosity.
80
81       --verbose-level
82              Level  of  debugging detail in output. Defaults to the number of
83              --verbose flags specified on the command line, or to 1  if  ver‐
84              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
85
86
87       -D, --debug-file=[debugfile]
88              Write debug information to given file
89
90       -V, --version
91              Display version information and exit
92
93       -h, --help
94              Display help and exit
95
96       --plug-separator=[char]
97              Separator for plug parameter when specifying more  than  1  plug
98              (Default Value: ,)
99
100       -C, --separator=[char]
101              Separator for CSV created by 'list' operation (Default Value: ,)
102
103
104       --delay=[seconds]
105              Wait X seconds before fencing  is  started  (Default  Value:  0)
106
107
108       --disable-timeout=[true/false]
109              Disable  timeout (true/false) (default: true when run from Pace‐
110              maker 2.0+)
111
112       --login-timeout=[seconds]
113              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
114
115
116       --power-timeout=[seconds]
117              Test  X  seconds  for status change after ON/OFF (Default Value:
118              20)
119
120       --power-wait=[seconds]
121              Wait X seconds after issuing ON/OFF (Default Value: 0)
122
123       --shell-timeout=[seconds]
124              Wait X seconds for cmd prompt  after  issuing  command  (Default
125              Value: 3)
126
127       --stonith-status-sleep=[seconds]
128              Sleep  X  seconds  between  status calls during a STONITH action
129              (Default Value: 1)
130
131       --retry-on=[attempts]
132              Count of attempts to retry power on (Default Value: 1)
133
134       --snmpget-path=[path]
135              Path to snmpget binary (Default Value: /usr/bin/snmpget)
136
137       --snmpset-path=[path]
138              Path to snmpset binary (Default Value: /usr/bin/snmpset)
139
140       --snmpwalk-path=[path]
141              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
142
143

ACTIONS

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

STDIN PARAMETERS

175
176
177       action Fencing action (Default Value: off)
178
179       community
180              Set the community string
181
182       ip     IP  address  or hostname of fencing device This parameter is al‐
183              ways required. Obsoletes: ipaddr
184
185       ipport TCP/UDP port to use for connection with device  (Default  Value:
186              161)
187
188       password
189              Login password or passphrase Obsoletes: passwd
190
191       password_script
192              Script  to  run  to  retrieve  password Obsoletes: passwd_script
193
194
195       plug   Physical plug number on device, UUID or  identification  of  ma‐
196              chine  This  parameter is always required. Obsoletes: port
197
198
199       snmp_auth_prot
200              Set authentication protocol (MD5|SHA)
201
202       snmp_priv_passwd
203              Set privacy protocol password
204
205       snmp_priv_passwd_script
206              Script to run to retrieve privacy password
207
208       snmp_priv_prot
209              Set privacy protocol (DES|AES)
210
211       snmp_sec_level
212              Set security level (noAuthNoPriv|authNoPriv|authPriv)
213
214       snmp_version
215              Specifies SNMP version to use (1|2c|3) (Default Value: 2c)
216
217       username
218              Login name Obsoletes: login
219
220       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
221              file or logging to syslog.
222
223       verbose
224              Verbose  mode.  Multiple  -v flags can be stacked on the command
225              line (e.g., -vvv) to increase verbosity.
226
227       verbose_level
228              Level of debugging detail in output. Defaults to the  number  of
229              --verbose  flags  specified on the command line, or to 1 if ver‐
230              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
231
232
233       debug_file
234              Write debug information to given file Obsoletes: debug
235
236       version
237              Display version information and exit
238
239       help   Display help and exit
240
241       plug_separator
242              Separator  for  plug  parameter when specifying more than 1 plug
243              (Default Value: ,)
244
245       separator
246              Separator for CSV created by 'list' operation (Default Value: ,)
247
248
249       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
250
251
252       disable_timeout
253              Disable timeout (true/false) (default: true when run from  Pace‐
254              maker 2.0+)
255
256       login_timeout
257              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
258
259
260       power_timeout
261              Test X seconds for status change after  ON/OFF  (Default  Value:
262              20)
263
264       power_wait
265              Wait X seconds after issuing ON/OFF (Default Value: 0)
266
267       shell_timeout
268              Wait  X  seconds  for  cmd prompt after issuing command (Default
269              Value: 3)
270
271       stonith_status_sleep
272              Sleep X seconds between status calls  during  a  STONITH  action
273              (Default Value: 1)
274
275       retry_on
276              Count of attempts to retry power on (Default Value: 1)
277
278       snmpget_path
279              Path to snmpget binary (Default Value: /usr/bin/snmpget)
280
281       snmpset_path
282              Path to snmpset binary (Default Value: /usr/bin/snmpset)
283
284       snmpwalk_path
285              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
286
287
288
289fence_ifmib (Fence Agent)         2009-10-20                    FENCE_AGENT(8)