fence_ifmib(8)

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

ACTIONS

118
119
120       on     Power on machine.
121
122       off    Power off machine.
123
124       reboot Reboot machine.
125
126       status This returns the status of the plug/virtual machine.
127
128       list   List  available  plugs with aliases/virtual machines if there is
129              support for more then one device. Returns N/A otherwise.
130
131       monitor
132              Check if fencing device is running. List available plugs/virtual
133              machines or get status of machine (if it does not support more).
134
135
136       metadata
137               The operational behavior of this is not known.
138
139

STDIN PARAMETERS

141
142
143       action Fencing Action (Default Value: reboot)
144
145       ipaddr IP Address or Hostname This parameter is always required.
146
147       login  Login Name
148
149       passwd Login password or passphrase
150
151       passwd_script
152              Script to retrieve password
153
154       port   Physical plug number or name of virtual machine  This  parameter
155              is always required.
156
157       snmp_version
158              Specifies SNMP version to use (1,2c,3)
159
160       community
161              Set the community string
162
163       snmp_auth_prot
164              Set authentication protocol (MD5|SHA)
165
166       snmp_sec_level
167              Set security level (noAuthNoPriv|authNoPriv|authPriv)
168
169       snmp_priv_prot
170              Set privacy protocol (DES|AES)
171
172       snmp_priv_passwd
173              Set privacy protocol password
174
175       snmp_priv_passwd_script
176              Script to run to retrieve privacy password
177
178       udpport
179              UDP/TCP  port  to use for connection with device (Default Value:
180              161)
181
182       inet4_only
183              Forces agent to use IPv4 addresses only
184
185       inet6_only
186              Forces agent to use IPv6 addresses only
187
188       verbose
189              Verbose mode
190
191       debug  Write debug information to given file
192
193       version
194              Display version information and exit
195
196       help   Display help and exit
197
198       separator
199              Separator for CSV created by operation list (Default  Value:  ,)
200
201
202       power_timeout
203              Test  X  seconds  for status change after ON/OFF (Default Value:
204              20)
205
206       shell_timeout
207              Wait X seconds for cmd prompt  after  issuing  command  (Default
208              Value: 3)
209
210       login_timeout
211              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
212
213
214       power_wait
215              Wait X seconds after issuing ON/OFF (Default Value: 0)
216
217       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
218
219
220       retry_on
221              Count of attempts to retry power on (Default Value: 1)
222
223
224
225fence_ifmib (Fence Agent)         2009-10-20                    FENCE_AGENT(8)