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

ACTIONS

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

STDIN PARAMETERS

167
168
169       action Fencing action (Default Value: reboot)
170
171       inet4_only
172              Forces agent to use IPv4 addresses only
173
174       inet6_only
175              Forces agent to use IPv6 addresses only
176
177       ip     IP  address  or  hostname  of  fencing  device This parameter is
178              always required. Obsoletes: ipaddr
179
180       ipport TCP/UDP port to use for connection with device  (Default  Value:
181              44444)
182
183       method Method to fence (onoff|cycle) (Default Value: onoff)
184
185
186       password
187              Login password or passphrase Obsoletes: passwd
188
189       password_script
190              Script to run  to  retrieve  password  Obsoletes:  passwd_script
191
192
193       plug   Physical  plug  number  on  device,  UUID  or  identification of
194              machine This parameter is always required. Obsoletes: port
195
196
197       username
198              Login  name  This parameter is always required. Obsoletes: login
199
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       missing_as_off
238              Missing  port  returns OFF instead of failure (Default Value: 1)
239
240
241       power_timeout
242              Test X seconds for status change after  ON/OFF  (Default  Value:
243              20)
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: 5)
251
252       retry_on
253              Count of attempts to retry power on (Default Value: 1)
254
255
256
257fence_zvmip (Fence Agent)         2009-10-20                    FENCE_AGENT(8)