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
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to run to retrieve password
55
56       -n, --plug=[id]
57              Physical  plug  number  on  device,  UUID  or  identification of
58              machine This parameter is always required.
59
60       -x, --ssh
61              Use SSH connection (Default Value: 1)
62
63       --ssh-options=[options]
64              SSH options to use
65
66       -l, --username=[name]
67              Login name This parameter is always required.
68
69       -q, --quiet
70              Disable logging to stderr. Does not affect --verbose or --debug-
71              file or logging to syslog.
72
73       -v, --verbose
74              Verbose mode
75
76       -D, --debug-file=[debugfile]
77              Write debug information to given file
78
79       -V, --version
80              Display version information and exit
81
82       -h, --help
83              Display help and exit
84
85       -C, --separator=[char]
86              Separator for CSV created by 'list' operation (Default Value: ,)
87
88
89       --delay=[seconds]
90              Wait X seconds before fencing  is  started  (Default  Value:  0)
91
92
93       --login-timeout=[seconds]
94              Wait  X  seconds  for cmd prompt after login (Default Value: 15)
95
96
97       --power-timeout=[seconds]
98              Test X seconds for status change after  ON/OFF  (Default  Value:
99              20)
100
101       --power-wait=[seconds]
102              Wait X seconds after issuing ON/OFF (Default Value: 0)
103
104       --shell-timeout=[seconds]
105              Wait  X  seconds  for  cmd prompt after issuing command (Default
106              Value: 3)
107
108       --retry-on=[attempts]
109              Count of attempts to retry power on (Default Value: 1)
110
111       --ssh-path=[path]
112              Path to ssh binary (Default Value: /usr/bin/ssh)
113
114

ACTIONS

116
117
118       on     Power on machine.
119
120       off    Power off machine.
121
122       reboot Reboot machine.
123
124       status This returns the status of the plug/virtual machine.
125
126       list   List available plugs with aliases/virtual machines if  there  is
127              support for more then one device. Returns N/A otherwise.
128
129       list-status
130              List  available  plugs  with  aliases/virtual machines and their
131              power state if it can be obtained without  additional  commands.
132
133
134       monitor
135              Check the health of fence device
136
137       metadata
138              Display the XML metadata describing this resource.
139
140       manpage
141               The operational behavior of this is not known.
142
143       validate-all
144              Validate if all required parameters are entered.
145
146

STDIN PARAMETERS

148
149
150       action Fencing action (Default Value: reboot)
151
152       command_prompt
153              Force  Python  regex  for command prompt (Default Value: [':~>',
154              ']\$', '\$ ']) Obsoletes: cmd_prompt
155
156       hmc_version
157              Force HMC version to use (3|4|ivm) (Default Value: 4)
158
159       identity_file
160              Identity file (private key) for SSH
161
162       inet4_only
163              Forces agent to use IPv4 addresses only
164
165       inet6_only
166              Forces agent to use IPv6 addresses only
167
168       ip     IP address or hostname  of  fencing  device  This  parameter  is
169              always required. Obsoletes: ipaddr
170
171       ipport TCP/UDP  port  to use for connection with device (Default Value:
172              22)
173
174       managed
175              Managed system name
176
177       password
178              Login password or passphrase Obsoletes: passwd
179
180       password_script
181              Script to run  to  retrieve  password  Obsoletes:  passwd_script
182
183
184       plug   Physical  plug  number  on  device,  UUID  or  identification of
185              machine This parameter is always required. Obsoletes: port
186
187
188       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
189
190       ssh_options
191              SSH options to use
192
193       username
194              Login  name  This parameter is always required. Obsoletes: login
195
196
197       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
198              file or logging to syslog.
199
200       verbose
201              Verbose mode
202
203       debug_file
204              Write debug information to given file Obsoletes: debug
205
206       version
207              Display version information and exit
208
209       help   Display help and exit
210
211       separator
212              Separator for CSV created by 'list' operation (Default Value: ,)
213
214
215       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
216
217
218       login_timeout
219              Wait  X  seconds  for cmd prompt after login (Default Value: 15)
220
221
222       power_timeout
223              Test X seconds for status change after  ON/OFF  (Default  Value:
224              20)
225
226       power_wait
227              Wait X seconds after issuing ON/OFF (Default Value: 0)
228
229       shell_timeout
230              Wait  X  seconds  for  cmd prompt after issuing command (Default
231              Value: 3)
232
233       retry_on
234              Count of attempts to retry power on (Default Value: 1)
235
236       ssh_path
237              Path to ssh binary (Default Value: /usr/bin/ssh)
238
239
240
241fence_lpar (Fence Agent)          2009-10-20                    FENCE_AGENT(8)