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

NAME

7       fence_zvmip - Fence agent for use with z/VM Virtual Machines
8

DESCRIPTION

10       The fence_zvm agent is intended to be used with with z/VM SMAPI service
11       via TCP/IP
12
13       To  use this agent the z/VM SMAPI service needs to be configured to al‐
14       low  the  virtual machine running this agent to connect to it and issue
15       the image_recycle operation.  This involves updating the VSMWORK1 AUTH‐
16       LIST  VMSYS:VSMWORK1.  file. The entry should look something similar to
17       this:
18
19       Column 1                   Column 66                Column 131
20
21          |                          |                        |
22          V                          V                        V
23
24       XXXXXXXX                      ALL                      IMAGE_CHARACTER‐
25       ISTICS
26
27       Where  XXXXXXX  is the name of the virtual machine used in the authuser
28       field of the request. This virtual machine also has to be authorized to
29       access the system's directory manager.
30
31
32       fence_zvmip  accepts options on the command line as well as from stdin.
33       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
34       fence_zvmip  can  be  run by itself with command line options.  This is
35       useful for testing and for turning outlets on or off from scripts.
36
37       Vendor URL: http://www.ibm.com
38

PARAMETERS

40
41
42       -o, --action=[action]
43              Fencing action (Default Value: reboot)
44
45       -4, --inet4-only
46              Forces agent to use IPv4 addresses only
47
48       -6, --inet6-only
49              Forces agent to use IPv6 addresses only
50
51       -a, --ip=[ip]
52              IP address or hostname of fencing device This parameter  is  al‐
53              ways required.
54
55       -u, --ipport=[port]
56              TCP/UDP  port  to use for connection with device (Default Value:
57              44444)
58
59       -m, --method=[method]
60              Method to fence (onoff|cycle) (Default Value: onoff)
61
62
63       -p, --password=[password]
64              Login password or passphrase
65
66       -S, --password-script=[script]
67              Script to run to retrieve password
68
69       -n, --plug=[id]
70              Physical  plug  number  on device, UUID or identification of ma‐
71              chine This parameter is always required.
72
73       -z, --ssl
74              Use SSL connection with verifying certificate (Default) (Default
75              Value: 1)
76
77       --ssl-insecure
78              Use SSL connection without verifying certificate
79
80       --ssl-secure
81              Use SSL connection with verifying certificate
82
83       -l, --username=[name]
84              Login name This parameter is always required.
85
86       --disable-ssl
87              Don't use SSL
88
89       -q, --quiet
90              Disable logging to stderr. Does not affect --verbose or --debug-
91              file or logging to syslog.
92
93       -v, --verbose
94              Verbose mode. Multiple -v flags can be stacked  on  the  command
95              line (e.g., -vvv) to increase verbosity.
96
97       --verbose-level
98              Level  of  debugging detail in output. Defaults to the number of
99              --verbose flags specified on the command line, or to 1  if  ver‐
100              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
101
102
103       -D, --debug-file=[debugfile]
104              Write debug information to given file
105
106       -V, --version
107              Display version information and exit
108
109       -h, --help
110              Display help and exit
111
112       --plug-separator=[char]
113              Separator for plug parameter when specifying more  than  1  plug
114              (Default Value: ,)
115
116       -C, --separator=[char]
117              Separator for CSV created by 'list' operation (Default Value: ,)
118
119
120       --delay=[seconds]
121              Wait X seconds before fencing  is  started  (Default  Value:  0)
122
123
124       --disable-timeout=[true/false]
125              Disable  timeout (true/false) (default: true when run from Pace‐
126              maker 2.0+)
127
128       --login-timeout=[seconds]
129              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
130
131
132       --missing-as-off
133              Missing  port  returns OFF instead of failure (Default Value: 1)
134
135
136       --power-timeout=[seconds]
137              Test X seconds for status change after  ON/OFF  (Default  Value:
138              20)
139
140       --power-wait=[seconds]
141              Wait X seconds after issuing ON/OFF (Default Value: 0)
142
143       --shell-timeout=[seconds]
144              Wait  X  seconds  for  cmd prompt after issuing command (Default
145              Value: 5)
146
147       --stonith-status-sleep=[seconds]
148              Sleep X seconds between status calls  during  a  STONITH  action
149              (Default Value: 1)
150
151       --retry-on=[attempts]
152              Count of attempts to retry power on (Default Value: 1)
153
154       --gnutlscli-path=[path]
155              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
156
157

ACTIONS

159
160
161       on     Power on machine.
162
163       off    Power off machine.
164
165       reboot Reboot machine.
166
167       status This returns the status of the plug/virtual machine.
168
169       list   List  available  plugs with aliases/virtual machines if there is
170              support for more then one device. Returns N/A otherwise.
171
172       list-status
173              List available plugs with  aliases/virtual  machines  and  their
174              power  state  if it can be obtained without additional commands.
175
176
177       monitor
178              Check the health of fence device
179
180       metadata
181              Display the XML metadata describing this resource.
182
183       manpage
184               The operational behavior of this is not known.
185
186       validate-all
187              Validate if all required parameters are entered.
188
189

STDIN PARAMETERS

191
192
193       action Fencing action (Default Value: reboot)
194
195       inet4_only
196              Forces agent to use IPv4 addresses only
197
198       inet6_only
199              Forces agent to use IPv6 addresses only
200
201       ip     IP address or hostname of fencing device This parameter  is  al‐
202              ways required. Obsoletes: ipaddr
203
204       ipport TCP/UDP  port  to use for connection with device (Default Value:
205              44444)
206
207       method Method to fence (onoff|cycle) (Default Value: onoff)
208
209
210       password
211              Login password or passphrase Obsoletes: passwd
212
213       password_script
214              Script  to  run  to  retrieve  password Obsoletes: passwd_script
215
216
217       plug   Physical plug number on device, UUID or  identification  of  ma‐
218              chine  This  parameter is always required. Obsoletes: port
219
220
221       ssl    Use SSL connection with verifying certificate (Default) (Default
222              Value: 1)
223
224       ssl_insecure
225              Use SSL connection without verifying certificate
226
227       ssl_secure
228              Use SSL connection with verifying certificate
229
230       username
231              Login  name  This parameter is always required. Obsoletes: login
232
233
234       disable_ssl
235              Don't use SSL
236
237       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
238              file or logging to syslog.
239
240       verbose
241              Verbose  mode.  Multiple  -v flags can be stacked on the command
242              line (e.g., -vvv) to increase verbosity.
243
244       verbose_level
245              Level of debugging detail in output. Defaults to the  number  of
246              --verbose  flags  specified on the command line, or to 1 if ver‐
247              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
248
249
250       debug_file
251              Write debug information to given file Obsoletes: debug
252
253       version
254              Display version information and exit
255
256       help   Display help and exit
257
258       plug_separator
259              Separator  for  plug  parameter when specifying more than 1 plug
260              (Default Value: ,)
261
262       separator
263              Separator for CSV created by 'list' operation (Default Value: ,)
264
265
266       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
267
268
269       disable_timeout
270              Disable timeout (true/false) (default: true when run from  Pace‐
271              maker 2.0+)
272
273       login_timeout
274              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
275
276
277       missing_as_off
278              Missing port returns OFF instead of failure (Default  Value:  1)
279
280
281       power_timeout
282              Test  X  seconds  for status change after ON/OFF (Default Value:
283              20)
284
285       power_wait
286              Wait X seconds after issuing ON/OFF (Default Value: 0)
287
288       shell_timeout
289              Wait X seconds for cmd prompt  after  issuing  command  (Default
290              Value: 5)
291
292       stonith_status_sleep
293              Sleep  X  seconds  between  status calls during a STONITH action
294              (Default Value: 1)
295
296       retry_on
297              Count of attempts to retry power on (Default Value: 1)
298
299       gnutlscli_path
300              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
301
302
303
304fence_zvmip (Fence Agent)         2009-10-20                    FENCE_AGENT(8)