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       -q, --quiet
69              Disable logging to stderr. Does not affect --verbose or --debug-
70              file or logging to syslog.
71
72       -v, --verbose
73              Verbose mode. Multiple -v flags can be stacked  on  the  command
74              line (e.g., -vvv) to increase verbosity.
75
76       --verbose-level
77              Level  of  debugging detail in output. Defaults to the number of
78              --verbose flags specified on the command line, or to 1  if  ver‐
79              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
80
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       -C, --separator=[char]
92              Separator for CSV created by 'list' operation (Default Value: ,)
93
94
95       --delay=[seconds]
96              Wait  X  seconds  before  fencing  is started (Default Value: 0)
97
98
99       --disable-timeout=[true/false]
100              Disable timeout (true/false) (default: true when run from  Pace‐
101              maker 2.0+)
102
103       --login-timeout=[seconds]
104              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
105
106
107       --power-timeout=[seconds]
108              Test X seconds for status change after  ON/OFF  (Default  Value:
109              300)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait  X  seconds  for  cmd prompt after issuing command (Default
116              Value: 3)
117
118       --stonith-status-sleep=[seconds]
119              Sleep X seconds between status calls  during  a  STONITH  action
120              (Default Value: 1)
121
122       --retry-on=[attempts]
123              Count of attempts to retry power on (Default Value: 1)
124
125

ACTIONS

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

STDIN PARAMETERS

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