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

NAME

7       fence_lpar - Fence agent for IBM LPAR
8

DESCRIPTION

10       fence_lpar  accepts  options on the command line as well as from stdin.
11       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
12       fence_lpar  can  be  run  by itself with command line options.  This is
13       useful for testing and for turning outlets on or off from scripts.
14
15       Vendor URL: http://www.ibm.com
16

PARAMETERS

18
19
20       -o, --action=[action]
21              Fencing action (Default Value: reboot)
22
23       -c, --command-prompt=[prompt]
24              Force Python regex for command prompt  (Default  Value:  [':~>',
25              ']\$', '\$ '])
26
27       -H, --hmc-version=[version]
28              Force HMC version to use (3|4|ivm) (Default Value: 4)
29
30       -k, --identity-file=[filename]
31              Identity file (private key) for SSH
32
33       -4, --inet4-only
34              Forces agent to use IPv4 addresses only
35
36       -6, --inet6-only
37              Forces agent to use IPv6 addresses only
38
39       -a, --ip=[ip]
40              IP  address  or hostname of fencing device This parameter is al‐
41              ways required.
42
43       -u, --ipport=[port]
44              TCP/UDP port to use for connection with device  (Default  Value:
45              22)
46
47       -s, --managed=[id]
48              Managed  system  name  This parameter is always required.
49
50
51       -p, --password=[password]
52              Login password or passphrase
53
54       -S, --password-script=[script]
55              Script to run to retrieve password
56
57       -n, --plug=[id]
58              Physical plug number on device, UUID or  identification  of  ma‐
59              chine This parameter is always required.
60
61       -x, --ssh
62              Use SSH connection (Default Value: 1)
63
64       --ssh-options=[options]
65              SSH options to use
66
67       -l, --username=[name]
68              Login name This parameter is always required.
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose mode. Multiple -v flags can be stacked  on  the  command
76              line (e.g., -vvv) to increase verbosity.
77
78       --verbose-level
79              Level  of  debugging detail in output. Defaults to the number of
80              --verbose flags specified on the command line, or to 1  if  ver‐
81              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
82
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       --plug-separator=[char]
94              Separator for plug parameter when specifying more  than  1  plug
95              (Default Value: ,)
96
97       -C, --separator=[char]
98              Separator for CSV created by 'list' operation (Default Value: ,)
99
100
101       --delay=[seconds]
102              Wait X seconds before fencing  is  started  (Default  Value:  0)
103
104
105       --disable-timeout=[true/false]
106              Disable  timeout (true/false) (default: true when run from Pace‐
107              maker 2.0+)
108
109       --login-timeout=[seconds]
110              Wait X seconds for cmd prompt after login  (Default  Value:  15)
111
112
113       --power-timeout=[seconds]
114              Test  X  seconds  for status change after ON/OFF (Default Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 0)
119
120       --shell-timeout=[seconds]
121              Wait X seconds for cmd prompt  after  issuing  command  (Default
122              Value: 3)
123
124       --stonith-status-sleep=[seconds]
125              Sleep  X  seconds  between  status calls during a STONITH action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --ssh-path=[path]
132              Path to ssh binary (Default Value: /usr/bin/ssh)
133
134

ACTIONS

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

STDIN PARAMETERS

168
169
170       action Fencing action (Default Value: reboot)
171
172       command_prompt
173              Force  Python  regex  for command prompt (Default Value: [':~>',
174              ']\$', '\$ ']) Obsoletes: cmd_prompt
175
176       hmc_version
177              Force HMC version to use (3|4|ivm) (Default Value: 4)
178
179       identity_file
180              Identity file (private key) for SSH
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       ip     IP address or hostname of fencing device This parameter  is  al‐
189              ways required. Obsoletes: ipaddr
190
191       ipport TCP/UDP  port  to use for connection with device (Default Value:
192              22)
193
194       managed
195              Managed system name This parameter is  always  required.
196
197
198       password
199              Login password or passphrase Obsoletes: passwd
200
201       password_script
202              Script  to  run  to  retrieve  password Obsoletes: passwd_script
203
204
205       plug   Physical plug number on device, UUID or  identification  of  ma‐
206              chine  This  parameter is always required. Obsoletes: port
207
208
209       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
210
211       ssh_options
212              SSH options to use
213
214       username
215              Login name This parameter is always required.  Obsoletes:  login
216
217
218       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
219              file or logging to syslog.
220
221       verbose
222              Verbose mode. Multiple -v flags can be stacked  on  the  command
223              line (e.g., -vvv) to increase verbosity.
224
225       verbose_level
226              Level  of  debugging detail in output. Defaults to the number of
227              --verbose flags specified on the command line, or to 1  if  ver‐
228              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
229
230
231       debug_file
232              Write debug information to given file Obsoletes: debug
233
234       version
235              Display version information and exit
236
237       help   Display help and exit
238
239       plug_separator
240              Separator for plug parameter when specifying more  than  1  plug
241              (Default Value: ,)
242
243       separator
244              Separator for CSV created by 'list' operation (Default Value: ,)
245
246
247       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
248
249
250       disable_timeout
251              Disable  timeout (true/false) (default: true when run from Pace‐
252              maker 2.0+)
253
254       login_timeout
255              Wait X seconds for cmd prompt after login  (Default  Value:  15)
256
257
258       power_timeout
259              Test  X  seconds  for status change after ON/OFF (Default Value:
260              20)
261
262       power_wait
263              Wait X seconds after issuing ON/OFF (Default Value: 0)
264
265       shell_timeout
266              Wait X seconds for cmd prompt  after  issuing  command  (Default
267              Value: 3)
268
269       stonith_status_sleep
270              Sleep  X  seconds  between  status calls during a STONITH action
271              (Default Value: 1)
272
273       retry_on
274              Count of attempts to retry power on (Default Value: 1)
275
276       ssh_path
277              Path to ssh binary (Default Value: /usr/bin/ssh)
278
279
280
281fence_lpar (Fence Agent)          2009-10-20                    FENCE_AGENT(8)