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       -C, --separator=[char]
94              Separator for CSV created by 'list' operation (Default Value: ,)
95
96
97       --delay=[seconds]
98              Wait  X  seconds  before  fencing  is started (Default Value: 0)
99
100
101       --disable-timeout=[true/false]
102              Disable timeout (true/false) (default: true when run from  Pace‐
103              maker 2.0+)
104
105       --login-timeout=[seconds]
106              Wait  X  seconds  for cmd prompt after login (Default Value: 15)
107
108
109       --power-timeout=[seconds]
110              Test X seconds for status change after  ON/OFF  (Default  Value:
111              20)
112
113       --power-wait=[seconds]
114              Wait X seconds after issuing ON/OFF (Default Value: 0)
115
116       --shell-timeout=[seconds]
117              Wait  X  seconds  for  cmd prompt after issuing command (Default
118              Value: 3)
119
120       --stonith-status-sleep=[seconds]
121              Sleep X seconds between status calls  during  a  STONITH  action
122              (Default Value: 1)
123
124       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127       --ssh-path=[path]
128              Path to ssh binary (Default Value: /usr/bin/ssh)
129
130

ACTIONS

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

STDIN PARAMETERS

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