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       --plug-separator=[char]
114              Separator for plug parameter when specifying more  than  1  plug
115              (Default Value: ,)
116
117       --delay=[seconds]
118              Wait  X  seconds  before  fencing  is started (Default Value: 0)
119
120
121       --disable-timeout=[true/false]
122              Disable timeout (true/false) (default: true when run from  Pace‐
123              maker 2.0+)
124
125       --login-timeout=[seconds]
126              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
127
128
129       --port-as-ip
130              Make "port/plug" to be an alias to IP address
131
132       --power-timeout=[seconds]
133              Test X seconds for status change after  ON/OFF  (Default  Value:
134              20)
135
136       --power-wait=[seconds]
137              Wait X seconds after issuing ON/OFF (Default Value: 0)
138
139       --shell-timeout=[seconds]
140              Wait  X  seconds  for  cmd prompt after issuing command (Default
141              Value: 3)
142
143       --stonith-status-sleep=[seconds]
144              Sleep X seconds between status calls  during  a  STONITH  action
145              (Default Value: 1)
146
147       --retry-on=[attempts]
148              Count of attempts to retry power on (Default Value: 1)
149
150       --ssh-path=[path]
151              Path to ssh binary (Default Value: /usr/bin/ssh)
152
153

ACTIONS

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

STDIN PARAMETERS

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