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 Value: 1)
75
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       -q, --quiet
87              Disable logging to stderr. Does not affect --verbose or --debug-
88              file or logging to syslog.
89
90       -v, --verbose
91              Verbose mode. Multiple -v flags can be stacked  on  the  command
92              line (e.g., -vvv) to increase verbosity.
93
94       --verbose-level
95              Level  of  debugging detail in output. Defaults to the number of
96              --verbose flags specified on the command line, or to 1  if  ver‐
97              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
98
99
100       -D, --debug-file=[debugfile]
101              Write debug information to given file
102
103       -V, --version
104              Display version information and exit
105
106       -h, --help
107              Display help and exit
108
109       -C, --separator=[char]
110              Separator for CSV created by 'list' operation (Default Value: ,)
111
112
113       --delay=[seconds]
114              Wait  X  seconds  before  fencing  is started (Default Value: 0)
115
116
117       --disable-timeout=[true/false]
118              Disable timeout (true/false) (default: true when run from  Pace‐
119              maker 2.0+)
120
121       --login-timeout=[seconds]
122              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
123
124
125       --missing-as-off
126              Missing port returns OFF instead of failure (Default  Value:  1)
127
128
129       --power-timeout=[seconds]
130              Test  X  seconds  for status change after ON/OFF (Default Value:
131              20)
132
133       --power-wait=[seconds]
134              Wait X seconds after issuing ON/OFF (Default Value: 0)
135
136       --shell-timeout=[seconds]
137              Wait X seconds for cmd prompt  after  issuing  command  (Default
138              Value: 5)
139
140       --stonith-status-sleep=[seconds]
141              Sleep  X  seconds  between  status calls during a STONITH action
142              (Default Value: 1)
143
144       --retry-on=[attempts]
145              Count of attempts to retry power on (Default Value: 1)
146
147       --gnutlscli-path=[path]
148              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
149
150

ACTIONS

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

STDIN PARAMETERS

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