1FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
3
7 fence_zvmip - Fence agent for use with z/VM Virtual Machines
8
10 The fence_zvmip agent is intended to be used with the z/VM SMAPI ser‐
11 vice via TCP/IP.
12 The z/VM SMAPI service must be configured so that the virtual machine
14 running the agent can connect to the service, access the system's di‐
15 rectory manager, and shortly thereafter run image_deactivate and im‐
16 age_activate. This involves updating the VSMWORK1 NAMELIST and VSMWORK1
17 AUTHLIST VMSYS:VSMWORK1 files.
18 The NAMELIST entry assigns all the required functions to one nick and
20 should look similar to this:
21 :nick.ZVM_FENCE :list. IMAGE_ACTIVATE IMAGE_DEACTIVATE IMAGE_STA‐
23 TUS_QUERY CHECK_AUTHENTICATION IMAGE_NAME_QUERY_DM
24 The AUTHLIST entry authorizes the user to perform all the functions as‐
27 sociated with the nick, and should look similar to this:
28 Column 1 Column 66 Column 131
30 | | | V
32 V V
33 XXXXXXXX ALL ZVM_FENCE
35 where XXXXXXXX is the name of the user in the authuser field of the re‐
37 quest.
38 Refer to the official z/VM documentation for complete instructions and
40 reference materials.
41 fence_zvmip accepts options on the command line as well as from stdin.
44 Fenced sends parameters through stdin when it execs the agent.
45 fence_zvmip can be run by itself with command line options. This is
46 useful for testing and for turning outlets on or off from scripts.
47 Vendor URL: http://www.ibm.com
49
51 -o, --action=[action]
54 Fencing action (Default Value: reboot)
55 -4, --inet4-only
57 Forces agent to use IPv4 addresses only
58 -6, --inet6-only
60 Forces agent to use IPv6 addresses only
61 -a, --ip=[ip]
63 IP address or hostname of fencing device This parameter is al‐
64 ways required.
65 -u, --ipport=[port]
67 TCP/UDP port to use for connection with device (Default Value:
68 44444)
69 -m, --method=[method]
71 Method to fence (onoff|cycle) (Default Value: onoff)
72 -p, --password=[password]
75 Login password or passphrase
76 -S, --password-script=[script]
78 Script to run to retrieve password
79 -n, --plug=[id]
81 Physical plug number on device, UUID or identification of ma‐
82 chine This parameter is always required.
83 -z, --ssl
85 Use SSL connection with verifying certificate (Default) (Default
86 Value: 1)
87 --ssl-insecure
89 Use SSL connection without verifying certificate
90 --ssl-secure
92 Use SSL connection with verifying certificate
93 -l, --username=[name]
95 Login name This parameter is always required.
96 --disable-ssl
98 Don't use SSL
99 -q, --quiet
101 Disable logging to stderr. Does not affect --verbose or --debug-
102 file or logging to syslog.
103 -v, --verbose
105 Verbose mode. Multiple -v flags can be stacked on the command
106 line (e.g., -vvv) to increase verbosity.
107 --verbose-level
109 Level of debugging detail in output. Defaults to the number of
110 --verbose flags specified on the command line, or to 1 if ver‐
111 bose=1 in a stonith device configuration (i.e., on stdin).
112 -D, --debug-file=[debugfile]
115 Write debug information to given file
116 -V, --version
118 Display version information and exit
119 -h, --help
121 Display help and exit
122 --plug-separator=[char]
124 Separator for plug parameter when specifying more than 1 plug
125 (Default Value: ,)
126 -C, --separator=[char]
128 Separator for CSV created by 'list' operation (Default Value: ,)
129 --delay=[seconds]
132 Wait X seconds before fencing is started (Default Value: 0)
133 --disable-timeout=[true/false]
136 Disable timeout (true/false) (default: true when run from Pace‐
137 maker 2.0+)
138 --login-timeout=[seconds]
140 Wait X seconds for cmd prompt after login (Default Value: 5)
141 --missing-as-off
144 Missing port returns OFF instead of failure (Default Value: 1)
145 --power-timeout=[seconds]
148 Test X seconds for status change after ON/OFF (Default Value:
149 20)
150 --power-wait=[seconds]
152 Wait X seconds after issuing ON/OFF (Default Value: 0)
153 --shell-timeout=[seconds]
155 Wait X seconds for cmd prompt after issuing command (Default
156 Value: 5)
157 --stonith-status-sleep=[seconds]
159 Sleep X seconds between status calls during a STONITH action
160 (Default Value: 1)
161 --retry-on=[attempts]
163 Count of attempts to retry power on (Default Value: 1)
164 --gnutlscli-path=[path]
166 Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
167
170 on Power on machine.
173 off Power off machine.
175 reboot Reboot machine.
177 status This returns the status of the plug/virtual machine.
179 list List available plugs with aliases/virtual machines if there is
181 support for more then one device. Returns N/A otherwise.
182 list-status
184 List available plugs with aliases/virtual machines and their
185 power state if it can be obtained without additional commands.
186 monitor
189 Check the health of fence device
190 metadata
192 Display the XML metadata describing this resource.
193 manpage
195 The operational behavior of this is not known.
196 validate-all
198 Validate if all required parameters are entered.
199
202 action Fencing action (Default Value: reboot)
205 inet4_only
207 Forces agent to use IPv4 addresses only
208 inet6_only
210 Forces agent to use IPv6 addresses only
211 ip IP address or hostname of fencing device This parameter is al‐
213 ways required. Obsoletes: ipaddr
214 ipport TCP/UDP port to use for connection with device (Default Value:
216 44444)
217 method Method to fence (onoff|cycle) (Default Value: onoff)
219 password
222 Login password or passphrase Obsoletes: passwd
223 password_script
225 Script to run to retrieve password Obsoletes: passwd_script
226 plug Physical plug number on device, UUID or identification of ma‐
229 chine This parameter is always required. Obsoletes: port
230 ssl Use SSL connection with verifying certificate (Default) (Default
233 Value: 1)
234 ssl_insecure
236 Use SSL connection without verifying certificate
237 ssl_secure
239 Use SSL connection with verifying certificate
240 username
242 Login name This parameter is always required. Obsoletes: login
243 disable_ssl
246 Don't use SSL
247 quiet Disable logging to stderr. Does not affect --verbose or --debug-
249 file or logging to syslog.
250 verbose
252 Verbose mode. Multiple -v flags can be stacked on the command
253 line (e.g., -vvv) to increase verbosity.
254 verbose_level
256 Level of debugging detail in output. Defaults to the number of
257 --verbose flags specified on the command line, or to 1 if ver‐
258 bose=1 in a stonith device configuration (i.e., on stdin).
259 debug_file
262 Write debug information to given file Obsoletes: debug
263 version
265 Display version information and exit
266 help Display help and exit
268 plug_separator
270 Separator for plug parameter when specifying more than 1 plug
271 (Default Value: ,)
272 separator
274 Separator for CSV created by 'list' operation (Default Value: ,)
275 delay Wait X seconds before fencing is started (Default Value: 0)
278 disable_timeout
281 Disable timeout (true/false) (default: true when run from Pace‐
282 maker 2.0+)
283 login_timeout
285 Wait X seconds for cmd prompt after login (Default Value: 5)
286 missing_as_off
289 Missing port returns OFF instead of failure (Default Value: 1)
290 power_timeout
293 Test X seconds for status change after ON/OFF (Default Value:
294 20)
295 power_wait
297 Wait X seconds after issuing ON/OFF (Default Value: 0)
298 shell_timeout
300 Wait X seconds for cmd prompt after issuing command (Default
301 Value: 5)
302 stonith_status_sleep
304 Sleep X seconds between status calls during a STONITH action
305 (Default Value: 1)
306 retry_on
308 Count of attempts to retry power on (Default Value: 1)
309 gnutlscli_path
311 Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
312fence_zvmip (Fence Agent) 2009-10-20 FENCE_AGENT(8)