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

NAME

7       fence_vmware - Fence agent for VMWare
8

DESCRIPTION

10       fence_vmware  is an I/O Fencing agent which can be used with the VMware
11       ESX, VMware ESXi or VMware Server to fence virtual machines.
12
13       Before you can use this agent, it must be installed VI Perl Toolkit  or
14       vmrun command on every node you want to make fencing.
15
16       VI  Perl  Toolkit  is preferred for VMware ESX/ESXi and Virtual Center.
17       Vmrun command is only solution for VMware Server 1/2 (this command will
18       works  against ESX/ESXi 3.5 up2 and VC up2 too, but not cluster aware!)
19       and is available as part of VMware VIX API SDK package. VI Perl and VIX
20       API  SDK are both available from VMware web pages (not int RHEL reposi‐
21       tory!).
22
23       You can specify type of VMware you are connecting to with -d switch (or
24       vmware_type   for   stdin).   Possible  values  are  esx,  server2  and
25       server1.Default value is esx, which will use VI Perl. With server1  and
26       server2, vmrun command is used.
27
28       After  you  have successfully installed VI Perl Toolkit or VIX API, you
29       should be able to run fence_vmware_helper (part of this agent) or vmrun
30       command.  This  agent  supports  only vmrun from version 2.0.0 (VIX API
31       1.6.0).
32
33       fence_vmware accepts options on the command line as well as from stdin.
34       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
35       fence_vmware can be run by itself with command line options.   This  is
36       useful for testing and for turning outlets on or off from scripts.
37
38       Vendor URL: http://www.vmware.com
39

PARAMETERS

41
42
43       -o, --action=[action]
44              Fencing action (Default Value: reboot)
45
46       -e, --exec=[command]
47              Command to execute
48
49       -k, --identity-file=[filename]
50              Identity file (private key) for SSH
51
52       -4, --inet4-only
53              Forces agent to use IPv4 addresses only
54
55       -6, --inet6-only
56              Forces agent to use IPv6 addresses only
57
58       -a, --ip=[ip]
59              IP address or hostname of fencing device
60
61       -u, --ipport=[port]
62              TCP/UDP  port  to use for connection with device (Default Value:
63              22)
64
65       -p, --password=[password]
66              Login password or passphrase
67
68       -S, --password-script=[script]
69              Script to run to retrieve password
70
71       -n, --plug=[ip]
72              IP address or hostname of fencing device (together with  --port-
73              as-ip)
74
75       -x, --ssh
76              Use SSH connection (Default Value: 1)
77
78       --ssh-options=[options]
79              SSH options to use
80
81       -l, --username=[name]
82              Login name This parameter is always required.
83
84       -d, --vmware_type=[type]
85              Type of VMware to connect (Default Value: esx)
86
87       -s, --vmware-datacenter=[dc]
88              VMWare datacenter filter
89
90       -q, --quiet
91              Disable logging to stderr. Does not affect --verbose or --debug-
92              file or logging to syslog.
93
94       -v, --verbose
95              Verbose mode. Multiple -v flags can be stacked  on  the  command
96              line (e.g., -vvv) to increase verbosity.
97
98       --verbose-level
99              Level  of  debugging detail in output. Defaults to the number of
100              --verbose flags specified on the command line, or to 1  if  ver‐
101              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
102
103
104       -D, --debug-file=[debugfile]
105              Write debug information to given file
106
107       -V, --version
108              Display version information and exit
109
110       -h, --help
111              Display help and exit
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       --port-as-ip
126              Make "port/plug" to be an alias to IP address
127
128       --power-timeout=[seconds]
129              Test  X  seconds  for status change after ON/OFF (Default Value:
130              20)
131
132       --power-wait=[seconds]
133              Wait X seconds after issuing ON/OFF (Default Value: 0)
134
135       --shell-timeout=[seconds]
136              Wait X seconds for cmd prompt  after  issuing  command  (Default
137              Value: 3)
138
139       --stonith-status-sleep=[seconds]
140              Sleep  X  seconds  between  status calls during a STONITH action
141              (Default Value: 1)
142
143       --retry-on=[attempts]
144              Count of attempts to retry power on (Default Value: 1)
145
146       --ssh-path=[path]
147              Path to ssh binary (Default Value: /usr/bin/ssh)
148
149

ACTIONS

151
152
153       on     Power on machine.
154
155       off    Power off machine.
156
157       reboot Reboot machine.
158
159       status This returns the status of the plug/virtual machine.
160
161       monitor
162              Check the health of fence device
163
164       metadata
165              Display the XML metadata describing this resource.
166
167       manpage
168               The operational behavior of this is not known.
169
170       validate-all
171              Validate if all required parameters are entered.
172
173

STDIN PARAMETERS

175
176
177       action Fencing action (Default Value: reboot)
178
179       exec   Command to execute
180
181       identity_file
182              Identity file (private key) for SSH
183
184       inet4_only
185              Forces agent to use IPv4 addresses only
186
187       inet6_only
188              Forces agent to use IPv6 addresses only
189
190       ip     IP address or hostname of fencing device Obsoletes: ipaddr
191
192
193       ipport TCP/UDP  port  to use for connection with device (Default Value:
194              22)
195
196       password
197              Login password or passphrase Obsoletes: passwd
198
199       password_script
200              Script to run  to  retrieve  password  Obsoletes:  passwd_script
201
202
203       plug   IP  address or hostname of fencing device (together with --port-
204              as-ip) Obsoletes: port
205
206       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
207
208       ssh_options
209              SSH options to use
210
211       username
212              Login name This parameter is always required.  Obsoletes:  login
213
214
215       vmware_type
216              Type of VMware to connect (Default Value: esx)
217
218       vmware_datacenter
219              VMWare datacenter filter
220
221       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
222              file or logging to syslog.
223
224       verbose
225              Verbose mode. Multiple -v flags can be stacked  on  the  command
226              line (e.g., -vvv) to increase verbosity.
227
228       verbose_level
229              Level  of  debugging detail in output. Defaults to the number of
230              --verbose flags specified on the command line, or to 1  if  ver‐
231              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
232
233
234       debug_file
235              Write debug information to given file Obsoletes: debug
236
237       version
238              Display version information and exit
239
240       help   Display help and exit
241
242       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
243
244
245       disable_timeout
246              Disable  timeout (true/false) (default: true when run from Pace‐
247              maker 2.0+)
248
249       login_timeout
250              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
251
252
253       port_as_ip
254              Make "port/plug" to be an alias to IP address
255
256       power_timeout
257              Test  X  seconds  for status change after ON/OFF (Default Value:
258              20)
259
260       power_wait
261              Wait X seconds after issuing ON/OFF (Default Value: 0)
262
263       shell_timeout
264              Wait X seconds for cmd prompt  after  issuing  command  (Default
265              Value: 3)
266
267       stonith_status_sleep
268              Sleep  X  seconds  between  status calls during a STONITH action
269              (Default Value: 1)
270
271       retry_on
272              Count of attempts to retry power on (Default Value: 1)
273
274       ssh_path
275              Path to ssh binary (Default Value: /usr/bin/ssh)
276
277
278
279fence_vmware (Fence Agent)        2009-10-20                    FENCE_AGENT(8)