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       -4, --inet4-only
35              Forces agent to use IPv4 addresses only
36
37       -6, --inet6-only
38              Forces agent to use IPv6 addresses only
39
40       -a, --ip=[ip]
41              IP address or hostname  of  fencing  device  This  parameter  is
42              always required.
43
44       -u, --ipport=[port]
45              TCP/UDP  port  to use for connection with device (Default Value:
46              161)
47
48       -p, --password=[password]
49              Login password or passphrase
50
51       -S, --password-script=[script]
52              Script to run to retrieve password
53
54       -n, --plug=[id]
55              Physical plug  number  on  device,  UUID  or  identification  of
56              machine This parameter is always required.
57
58       -b, --snmp-auth-prot=[prot]
59              Set authentication protocol (MD5|SHA)
60
61       -P, --snmp-priv-passwd=[pass]
62              Set privacy protocol password
63
64       -R, --snmp-priv-passwd-script
65              Script to run to retrieve privacy password
66
67       -B, --snmp-priv-prot=[prot]
68              Set privacy protocol (DES|AES)
69
70       -E, --snmp-sec-level=[level]
71              Set security level (noAuthNoPriv|authNoPriv|authPriv)
72
73       -d, --snmp-version=[version]
74              Specifies SNMP version to use (1|2c|3) (Default Value: 2c)
75
76       -l, --username=[name]
77              Login name
78
79       -q, --quiet
80              Disable logging to stderr. Does not affect --verbose or --debug-
81              file or logging to syslog.
82
83       -v, --verbose
84              Verbose mode
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait  X  seconds  before  fencing  is started (Default Value: 0)
101
102
103       --login-timeout=[seconds]
104              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
105
106
107       --power-timeout=[seconds]
108              Test  X  seconds  for status change after ON/OFF (Default Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait X seconds for cmd prompt  after  issuing  command  (Default
116              Value: 3)
117
118       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121       --snmpget-path=[path]
122              Path to snmpget binary (Default Value: /usr/bin/snmpget)
123
124       --snmpset-path=[path]
125              Path to snmpset binary (Default Value: /usr/bin/snmpset)
126
127       --snmpwalk-path=[path]
128              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
129
130

ACTIONS

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

STDIN PARAMETERS

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