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 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 This parameter is always required.
60
61       -u, --ipport=[port]
62              TCP/UDP  port  to use for connection with device (Default Value:
63              22)
64
65       -l, --username=[name]
66              Login Name This parameter is always required.
67
68       -p, --password=[password]
69              Login password or passphrase
70
71       -S, --password-script=[script]
72              Script to retrieve password
73
74       -x, --ssh
75              SSH connection (Default Value: 1)
76
77       --ssh-options=[options]
78              SSH options to use
79
80       -d, --vmware_type=[type]
81              Type of VMware to connect (Default Value: esx)
82
83       -s, --vmware-datacenter=[dc]
84              Show only machines in specified datacenter
85
86       -v, --verbose
87              Verbose mode
88
89       -D, --debug-file=[debugfile]
90              Write debug information to given file
91
92       -V, --version
93              Display version information and exit
94
95       -h, --help
96              Display help and exit
97
98       --delay=[seconds]
99              Wait X seconds before fencing  is  started  (Default  Value:  0)
100
101
102       --login-timeout=[seconds]
103              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
104
105
106       --power-timeout=[seconds]
107              Test X seconds for status change after  ON/OFF  (Default  Value:
108              20)
109
110       --power-wait=[seconds]
111              Wait X seconds after issuing ON/OFF (Default Value: 0)
112
113       --shell-timeout=[seconds]
114              Wait  X  seconds  for  cmd prompt after issuing command (Default
115              Value: 3)
116
117       --retry-on=[attempts]
118              Count of attempts to retry power on (Default Value: 1)
119
120       --ssh-path=[path]
121              Path to ssh binary (Default Value: /usr/bin/ssh)
122
123

ACTIONS

125
126
127       on     Power on machine.
128
129       off    Power off machine.
130
131       reboot Reboot machine.
132
133       status This returns the status of the plug/virtual machine.
134
135       list   List available plugs with aliases/virtual machines if  there  is
136              support for more then one device. Returns N/A otherwise.
137
138       list-status
139              List  available  plugs  with  aliases/virtual machines and their
140              power state if it can be obtained without  additional  commands.
141
142
143       monitor
144              Check the health of fence device
145
146       metadata
147              Display the XML metadata describing this resource.
148
149

STDIN PARAMETERS

151
152
153       action Fencing Action (Default Value: reboot)
154
155       exec   Command to execute
156
157       identity_file
158              Identity file for ssh
159
160       inet4_only
161              Forces agent to use IPv4 addresses only
162
163       inet6_only
164              Forces agent to use IPv6 addresses only
165
166       ipaddr IP Address or Hostname This parameter is always required.
167
168       ipport TCP/UDP  port  to use for connection with device (Default Value:
169              22)
170
171       login  Login Name This parameter is always required.
172
173       passwd Login password or passphrase
174
175       passwd_script
176              Script to retrieve password
177
178       secure SSH connection (Default Value: 1)
179
180       ssh_options
181              SSH options to use
182
183       vmware_type
184              Type of VMware to connect (Default Value: esx)
185
186       vmware_datacenter
187              Show only machines in specified datacenter
188
189       verbose
190              Verbose mode
191
192       debug  Write debug information to given file
193
194       version
195              Display version information and exit
196
197       help   Display help and exit
198
199       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
200
201
202       login_timeout
203              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
204
205
206       power_timeout
207              Test X seconds for status change after  ON/OFF  (Default  Value:
208              20)
209
210       power_wait
211              Wait X seconds after issuing ON/OFF (Default Value: 0)
212
213       shell_timeout
214              Wait  X  seconds  for  cmd prompt after issuing command (Default
215              Value: 3)
216
217       retry_on
218              Count of attempts to retry power on (Default Value: 1)
219
220       ssh_path
221              Path to ssh binary (Default Value: /usr/bin/ssh)
222
223
224
225fence_vmware (Fence Agent)        2009-10-20                    FENCE_AGENT(8)