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

NAME

7       fence_ibmz - Fence agent for IBM z LPARs
8

DESCRIPTION

10       fence_ibmz is a power fencing agent which uses the HMC Web Services API
11       to fence IBM z LPARs.
12
13       fence_ibmz accepts options on the command line as well as  from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_ibmz can be run by itself with command  line  options.   This  is
16       useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.ibm.com
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -a, --ip=[ip]
27              IP  address  or hostname of fencing device This parameter is al‐
28              ways required.
29
30       -u, --ipport=[port]
31              TCP/UDP port to use for connection with device  (Default  Value:
32              6794)
33
34       -p, --password=[password]
35              Login password or passphrase
36
37       -S, --password-script=[script]
38              Script to run to retrieve password
39
40       -n, --plug=[id]
41              Physical  plug  id  in the format cpc-name/partition-name (case-
42              sensitive) This parameter is always required.
43
44       --ssl-secure
45              Use SSL connection with verifying certificate
46
47       -l, --username=[name]
48              Login name This parameter is always required.
49
50       --connect-retries=[number]
51              How many times to retry on connection errors (Default Value:  3)
52
53
54       --connect-timeout=[seconds]
55              How  long  to wait to establish a connection (Default Value: 30)
56
57
58       --operation-timeout=[seconds]
59              How long to wait for power operation to complete (Default Value:
60              900)
61
62       --read-retries=[number]
63              How many times to retry on read errors (Default Value: 3)
64
65       --read-timeout=[seconds]
66              How long to wait for server data (Default Value: 300)
67
68       --load-on-activate
69              Rely on the HMC to perform a load operation on activation
70
71       -q, --quiet
72              Disable logging to stderr. Does not affect --verbose or --debug-
73              file or logging to syslog.
74
75       -v, --verbose
76              Verbose mode. Multiple -v flags can be stacked  on  the  command
77              line (e.g., -vvv) to increase verbosity.
78
79       --verbose-level
80              Level  of  debugging detail in output. Defaults to the number of
81              --verbose flags specified on the command line, or to 1  if  ver‐
82              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
83
84
85       -D, --debug-file=[debugfile]
86              Write debug information to given file
87
88       -V, --version
89              Display version information and exit
90
91       -h, --help
92              Display help and exit
93
94       --plug-separator=[char]
95              Separator for plug parameter when specifying more  than  1  plug
96              (Default Value: ,)
97
98       -C, --separator=[char]
99              Separator for CSV created by 'list' operation (Default Value: ,)
100
101
102       --delay=[seconds]
103              Wait X seconds before fencing  is  started  (Default  Value:  0)
104
105
106       --disable-timeout=[true/false]
107              Disable  timeout (true/false) (default: true when run from Pace‐
108              maker 2.0+)
109
110       --login-timeout=[seconds]
111              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
112
113
114       --power-timeout=[seconds]
115              Test  X  seconds  for status change after ON/OFF (Default Value:
116              300)
117
118       --power-wait=[seconds]
119              Wait X seconds after issuing ON/OFF (Default Value: 0)
120
121       --shell-timeout=[seconds]
122              Wait X seconds for cmd prompt  after  issuing  command  (Default
123              Value: 3)
124
125       --stonith-status-sleep=[seconds]
126              Sleep  X  seconds  between  status calls during a STONITH action
127              (Default Value: 1)
128
129       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132

ACTIONS

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

STDIN PARAMETERS

166
167
168       action Fencing action (Default Value: reboot)
169
170       ip     IP  address  or hostname of fencing device This parameter is al‐
171              ways required. Obsoletes: ipaddr
172
173       ipport TCP/UDP port to use for connection with device  (Default  Value:
174              6794)
175
176       password
177              Login password or passphrase Obsoletes: passwd
178
179       password_script
180              Script  to  run  to  retrieve  password Obsoletes: passwd_script
181
182
183       plug   Physical plug id in the  format  cpc-name/partition-name  (case-
184              sensitive)  This  parameter  is always required. Obsoletes: port
185
186
187       ssl_secure
188              Use SSL connection with verifying certificate
189
190       username
191              Login name This parameter is always required.  Obsoletes:  login
192
193
194       connect_retries
195              How  many times to retry on connection errors (Default Value: 3)
196
197
198       connect_timeout
199              How long to wait to establish a connection (Default  Value:  30)
200
201
202       operation_timeout
203              How long to wait for power operation to complete (Default Value:
204              900)
205
206       read_retries
207              How many times to retry on read errors (Default Value: 3)
208
209       read_timeout
210              How long to wait for server data (Default Value: 300)
211
212       load_on_activate
213              Rely on the HMC to perform a load operation on activation
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose  mode.  Multiple  -v flags can be stacked on the command
220              line (e.g., -vvv) to increase verbosity.
221
222       verbose_level
223              Level of debugging detail in output. Defaults to the  number  of
224              --verbose  flags  specified on the command line, or to 1 if ver‐
225              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
226
227
228       debug_file
229              Write debug information to given file Obsoletes: debug
230
231       version
232              Display version information and exit
233
234       help   Display help and exit
235
236       plug_separator
237              Separator  for  plug  parameter when specifying more than 1 plug
238              (Default Value: ,)
239
240       separator
241              Separator for CSV created by 'list' operation (Default Value: ,)
242
243
244       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
245
246
247       disable_timeout
248              Disable timeout (true/false) (default: true when run from  Pace‐
249              maker 2.0+)
250
251       login_timeout
252              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
253
254
255       power_timeout
256              Test X seconds for status change after  ON/OFF  (Default  Value:
257              300)
258
259       power_wait
260              Wait X seconds after issuing ON/OFF (Default Value: 0)
261
262       shell_timeout
263              Wait  X  seconds  for  cmd prompt after issuing command (Default
264              Value: 3)
265
266       stonith_status_sleep
267              Sleep X seconds between status calls  during  a  STONITH  action
268              (Default Value: 1)
269
270       retry_on
271              Count of attempts to retry power on (Default Value: 1)
272
273
274
275fence_ibmz (Fence Agent)          2009-10-20                    FENCE_AGENT(8)