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
96
97       -D, --debug-file=[debugfile]
98              Write debug information to given file
99
100       -V, --version
101              Display version information and exit
102
103       -h, --help
104              Display help and exit
105
106       --delay=[seconds]
107              Wait X seconds before fencing  is  started  (Default  Value:  0)
108
109
110       --login-timeout=[seconds]
111              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
112
113
114       --port-as-ip
115              Make "port/plug" to be an alias to IP address
116
117       --power-timeout=[seconds]
118              Test X seconds for status change after  ON/OFF  (Default  Value:
119              20)
120
121       --power-wait=[seconds]
122              Wait X seconds after issuing ON/OFF (Default Value: 0)
123
124       --shell-timeout=[seconds]
125              Wait  X  seconds  for  cmd prompt after issuing command (Default
126              Value: 3)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --ssh-path=[path]
132              Path to ssh binary (Default Value: /usr/bin/ssh)
133
134

ACTIONS

136
137
138       on     Power on machine.
139
140       off    Power off machine.
141
142       reboot Reboot machine.
143
144       status This returns the status of the plug/virtual machine.
145
146       monitor
147              Check the health of fence device
148
149       metadata
150              Display the XML metadata describing this resource.
151
152       manpage
153               The operational behavior of this is not known.
154
155       validate-all
156              Validate if all required parameters are entered.
157
158

STDIN PARAMETERS

160
161
162       action Fencing action (Default Value: reboot)
163
164       exec   Command to execute
165
166       identity_file
167              Identity file (private key) for SSH
168
169       inet4_only
170              Forces agent to use IPv4 addresses only
171
172       inet6_only
173              Forces agent to use IPv6 addresses only
174
175       ip     IP address or hostname of fencing device Obsoletes: ipaddr
176
177
178       ipport TCP/UDP  port  to use for connection with device (Default Value:
179              22)
180
181       password
182              Login password or passphrase Obsoletes: passwd
183
184       password_script
185              Script to run  to  retrieve  password  Obsoletes:  passwd_script
186
187
188       plug   IP  address or hostname of fencing device (together with --port-
189              as-ip) Obsoletes: port
190
191       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
192
193       ssh_options
194              SSH options to use
195
196       username
197              Login name This parameter is always required.  Obsoletes:  login
198
199
200       vmware_type
201              Type of VMware to connect (Default Value: esx)
202
203       vmware_datacenter
204              VMWare datacenter filter
205
206       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
207              file or logging to syslog.
208
209       verbose
210              Verbose mode
211
212       debug_file
213              Write debug information to given file Obsoletes: debug
214
215       version
216              Display version information and exit
217
218       help   Display help and exit
219
220       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
221
222
223       login_timeout
224              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
225
226
227       port_as_ip
228              Make "port/plug" to be an alias to IP address
229
230       power_timeout
231              Test X seconds for status change after  ON/OFF  (Default  Value:
232              20)
233
234       power_wait
235              Wait X seconds after issuing ON/OFF (Default Value: 0)
236
237       shell_timeout
238              Wait  X  seconds  for  cmd prompt after issuing command (Default
239              Value: 3)
240
241       retry_on
242              Count of attempts to retry power on (Default Value: 1)
243
244       ssh_path
245              Path to ssh binary (Default Value: /usr/bin/ssh)
246
247
248
249fence_vmware (Fence Agent)        2009-10-20                    FENCE_AGENT(8)