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

ACTIONS

117
118
119       on     Power on machine.
120
121       off    Power off machine.
122
123       status This returns the status of the plug/virtual machine.
124
125       list   List available plugs with aliases/virtual machines if  there  is
126              support for more then one device. Returns N/A otherwise.
127
128       list-status
129              List  available  plugs  with  aliases/virtual machines and their
130              power state if it can be obtained without  additional  commands.
131
132
133       monitor
134              Check the health of fence device
135
136       metadata
137              Display the XML metadata describing this resource.
138
139

STDIN PARAMETERS

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