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       -a, --ip=<ip>
47              IP Address or Hostname This parameter is always required.
48
49       -l, --username=<name>
50              Login Name This parameter is always required.
51
52       -p, --password=<password>
53              Login password or passphrase
54
55       -S, --password-script=<script>
56              Script to retrieve password
57
58       -n, --plug=<id>
59              Physical  plug  number or name of virtual machine This parameter
60              is always required.
61
62       -e, --exec=<command>
63              Command to execute
64
65       -d, --vmware_type=<type>
66              Type of VMware to connect (Default Value: esx)
67
68       -x, --ssh
69              SSH connection (Default Value: true)
70
71       -k, --identity-file=<filename>
72              Identity file for ssh
73
74       -s, --vmware-datacenter=<dc>
75              Show only machines in specified datacenter
76
77       -v, --verbose
78              Verbose mode
79
80       -D, --debug-file=<debugfile>
81              Write debug information to given file
82
83       -V, --version
84              Display version information and exit
85
86       -h, --help
87              Display help and exit
88
89       -C, --separator=<char>
90              Separator for CSV created by operation list (Default  Value:  ,)
91
92
93       --power-timeout
94              Test  X  seconds  for status change after ON/OFF (Default Value:
95              20)
96
97       --shell-timeout
98              Wait X seconds for cmd prompt  after  issuing  command  (Default
99              Value: 3)
100
101       --login-timeout
102              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
103
104
105       --power-wait
106              Wait X seconds after issuing ON/OFF (Default Value: 0)
107
108       --delay
109              Wait X seconds before fencing  is  started  (Default  Value:  0)
110
111
112       --retry-on
113              Count of attempts to retry power on (Default Value: 1)
114
115

ACTIONS

117
118
119       on     Power on machine.
120
121       off    Power off machine.
122
123       reboot Reboot machine.
124
125       status This returns the status of the plug/virtual machine.
126
127       list   List  available  plugs with aliases/virtual machines if there is
128              support for more then one device. Returns N/A otherwise.
129
130       monitor
131              Check if fencing device is running. List available plugs/virtual
132              machines or get status of machine (if it does not support more).
133
134
135       metadata
136               The operational behavior of this is not known.
137
138

STDIN PARAMETERS

140
141
142       action Fencing Action (Default Value: reboot)
143
144       ipaddr IP Address or Hostname This parameter is always required.
145
146       login  Login Name This parameter is always required.
147
148       passwd Login password or passphrase
149
150       passwd_script
151              Script to retrieve password
152
153       port   Physical plug number or name of virtual machine  This  parameter
154              is always required.
155
156       exec   Command to execute
157
158       vmware_type
159              Type of VMware to connect (Default Value: esx)
160
161       secure SSH connection (Default Value: true)
162
163       identity_file
164              Identity file for ssh
165
166       vmware_datacenter
167              Show only machines in specified datacenter
168
169       verbose
170              Verbose mode
171
172       debug  Write debug information to given file
173
174       version
175              Display version information and exit
176
177       help   Display help and exit
178
179       separator
180              Separator  for  CSV created by operation list (Default Value: ,)
181
182
183       power_timeout
184              Test X seconds for status change after  ON/OFF  (Default  Value:
185              20)
186
187       shell_timeout
188              Wait  X  seconds  for  cmd prompt after issuing command (Default
189              Value: 3)
190
191       login_timeout
192              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
193
194
195       power_wait
196              Wait X seconds after issuing ON/OFF (Default Value: 0)
197
198       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
199
200
201       retry_on
202              Count of attempts to retry power on (Default Value: 1)
203
204
205
206fence_vmware (Fence Agent)        2009-10-20                    FENCE_AGENT(8)