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
41              always 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
59              machine 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       --retry-on=[attempts]
121              Count of attempts to retry power on (Default Value: 1)
122
123       --ssh-path=[path]
124              Path to ssh binary (Default Value: /usr/bin/ssh)
125
126

ACTIONS

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

STDIN PARAMETERS

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