1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_ipdu - Fence agent for iPDU over SNMP
8

DESCRIPTION

10       fence_ipdu  is an I/O Fencing agent which can be used with the IBM iPDU
11       network power switch. It logs into a device  via  SNMP  and  reboots  a
12       specified  outlet. It supports SNMP v3 with all combinations of authen‐
13       ticity/privacy settings.
14
15       fence_ipdu accepts options on the command line as well as  from  stdin.
16       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
17       fence_ipdu can be run by itself with command  line  options.   This  is
18       useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: http://www.ibm.com
21

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

161
162
163       action Fencing action (Default Value: reboot)
164
165       community
166              Set the community string (Default Value: private)
167
168       inet4_only
169              Forces agent to use IPv4 addresses only
170
171       inet6_only
172              Forces agent to use IPv6 addresses only
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: 3)
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
217
218       debug_file
219              Write debug information to given file Obsoletes: debug
220
221       version
222              Display version information and exit
223
224       help   Display help and exit
225
226       separator
227              Separator for CSV created by 'list' operation (Default Value: ,)
228
229
230       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
231
232
233       login_timeout
234              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
235
236
237       power_timeout
238              Test X seconds for status change after  ON/OFF  (Default  Value:
239              20)
240
241       power_wait
242              Wait X seconds after issuing ON/OFF (Default Value: 0)
243
244       shell_timeout
245              Wait  X  seconds  for  cmd prompt after issuing command (Default
246              Value: 3)
247
248       retry_on
249              Count of attempts to retry power on (Default Value: 1)
250
251       snmpget_path
252              Path to snmpget binary (Default Value: /usr/bin/snmpget)
253
254       snmpset_path
255              Path to snmpset binary (Default Value: /usr/bin/snmpset)
256
257       snmpwalk_path
258              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
259
260
261
262fence_ipdu (Fence Agent)          2009-10-20                    FENCE_AGENT(8)