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       -C, --separator=[char]
97              Separator for CSV created by 'list' operation (Default Value: ,)
98
99
100       --delay=[seconds]
101              Wait  X  seconds  before  fencing  is started (Default Value: 0)
102
103
104       --disable-timeout=[true/false]
105              Disable timeout (true/false) (default: true when run from  Pace‐
106              maker 2.0+)
107
108       --login-timeout=[seconds]
109              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
110
111
112       --power-timeout=[seconds]
113              Test X seconds for status change after  ON/OFF  (Default  Value:
114              20)
115
116       --power-wait=[seconds]
117              Wait X seconds after issuing ON/OFF (Default Value: 0)
118
119       --shell-timeout=[seconds]
120              Wait  X  seconds  for  cmd prompt after issuing command (Default
121              Value: 3)
122
123       --stonith-status-sleep=[seconds]
124              Sleep X seconds between status calls  during  a  STONITH  action
125              (Default Value: 1)
126
127       --retry-on=[attempts]
128              Count of attempts to retry power on (Default Value: 1)
129
130       --snmpget-path=[path]
131              Path to snmpget binary (Default Value: /usr/bin/snmpget)
132
133       --snmpset-path=[path]
134              Path to snmpset binary (Default Value: /usr/bin/snmpset)
135
136       --snmpwalk-path=[path]
137              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
138
139

ACTIONS

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

STDIN PARAMETERS

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