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
28              always 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       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121

ACTIONS

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

STDIN PARAMETERS

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