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
36              always 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
50              machine 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       --retry-on=[attempts]
124              Count of attempts to retry power on (Default Value: 1)
125
126       --snmpget-path=[path]
127              Path to snmpget binary (Default Value: /usr/bin/snmpget)
128
129       --snmpset-path=[path]
130              Path to snmpset binary (Default Value: /usr/bin/snmpset)
131
132       --snmpwalk-path=[path]
133              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
134
135

ACTIONS

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

STDIN PARAMETERS

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