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

NAME

7       fence_vmware_soap - Fence agent for VMWare over SOAP API
8

DESCRIPTION

10       fence_vmware_soap  is  an  I/O Fencing agent which can be used with the
11       virtual machines managed by VMWare products that have SOAP API v4.1+.
12
13       Name of virtual machine (-n / port) has to be used  in  inventory  path
14       format  (e.g.  /datacenter/vm/Discovered virtual machine/myMachine). In
15       the cases when name of yours VM is unique you can use it  instead.  Al‐
16       ternatively you can always use UUID to access virtual machine.
17
18       fence_vmware_soap  accepts  options on the command line as well as from
19       stdin. Fenced sends parameters through stdin when it execs  the  agent.
20       fence_vmware_soap can be run by itself with command line options.  This
21       is useful for testing and for turning outlets on or off from scripts.
22
23       Vendor URL: http://www.vmware.com
24

PARAMETERS

26
27
28       -o, --action=[action]
29              Fencing action (Default Value: reboot)
30
31       -a, --ip=[ip]
32              IP address or hostname of fencing device This parameter  is  al‐
33              ways required.
34
35       -u, --ipport=[port]
36              TCP/UDP  port  to use for connection with device (Default Value:
37              80)
38
39       -t, --notls
40              Disable TLS negotiation and force SSL3.0. This  should  only  be
41              used for devices that do not support TLS1.0 and up.
42
43
44       -p, --password=[password]
45              Login password or passphrase
46
47       -S, --password-script=[script]
48              Script to run to retrieve password
49
50       -n, --plug=[id]
51              Physical plug number on device, UUID or  identification  of  ma‐
52              chine This parameter is always required.
53
54       -z, --ssl
55              Use SSL connection with verifying certificate
56
57       --ssl-insecure
58              Use SSL connection without verifying certificate
59
60       --ssl-secure
61              Use SSL connection with verifying certificate
62
63       -l, --username=[name]
64              Login name This parameter is always required.
65
66       -q, --quiet
67              Disable logging to stderr. Does not affect --verbose or --debug-
68              file or logging to syslog.
69
70       -v, --verbose
71              Verbose mode. Multiple -v flags can be stacked  on  the  command
72              line (e.g., -vvv) to increase verbosity.
73
74       --verbose-level
75              Level  of  debugging detail in output. Defaults to the number of
76              --verbose flags specified on the command line, or to 1  if  ver‐
77              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
78
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       --plug-separator=[char]
90              Separator for plug parameter when specifying more  than  1  plug
91              (Default Value: ,)
92
93       -C, --separator=[char]
94              Separator for CSV created by 'list' operation (Default Value: ,)
95
96
97       --delay=[seconds]
98              Wait X seconds before fencing  is  started  (Default  Value:  0)
99
100
101       --disable-timeout=[true/false]
102              Disable  timeout (true/false) (default: true when run from Pace‐
103              maker 2.0+)
104
105       --login-timeout=[seconds]
106              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
107
108
109       --power-timeout=[seconds]
110              Test  X  seconds  for status change after ON/OFF (Default Value:
111              20)
112
113       --power-wait=[seconds]
114              Wait X seconds after issuing ON/OFF (Default Value: 0)
115
116       --shell-timeout=[seconds]
117              Wait X seconds for cmd prompt  after  issuing  command  (Default
118              Value: 3)
119
120       --stonith-status-sleep=[seconds]
121              Sleep  X  seconds  between  status calls during a STONITH action
122              (Default Value: 1)
123
124       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127       --gnutlscli-path=[path]
128              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
129
130

ACTIONS

132
133
134       on     Power on machine.
135
136       off    Power off machine.
137
138       reboot Reboot machine.
139
140       status This returns the status of the plug/virtual machine.
141
142       list   List available plugs with aliases/virtual machines if  there  is
143              support for more then one device. Returns N/A otherwise.
144
145       list-status
146              List  available  plugs  with  aliases/virtual machines and their
147              power state if it can be obtained without  additional  commands.
148
149
150       monitor
151              Check the health of fence device
152
153       metadata
154              Display the XML metadata describing this resource.
155
156       manpage
157               The operational behavior of this is not known.
158
159       validate-all
160              Validate if all required parameters are entered.
161
162

STDIN PARAMETERS

164
165
166       action Fencing action (Default Value: reboot)
167
168       ip     IP  address  or hostname of fencing device This parameter is al‐
169              ways required. Obsoletes: ipaddr
170
171       ipport TCP/UDP port to use for connection with device  (Default  Value:
172              80)
173
174       notls  Disable  TLS  negotiation  and force SSL3.0. This should only be
175              used for devices that do not support TLS1.0 and up.
176
177
178       password
179              Login password or passphrase Obsoletes: passwd
180
181       password_script
182              Script  to  run  to  retrieve  password Obsoletes: passwd_script
183
184
185       plug   Physical plug number on device, UUID or  identification  of  ma‐
186              chine  This  parameter is always required. Obsoletes: port
187
188
189       ssl    Use SSL connection with verifying certificate
190
191       ssl_insecure
192              Use SSL connection without verifying certificate
193
194       ssl_secure
195              Use SSL connection with verifying certificate
196
197       username
198              Login name This parameter is always required.  Obsoletes:  login
199
200
201       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
202              file or logging to syslog.
203
204       verbose
205              Verbose mode. Multiple -v flags can be stacked  on  the  command
206              line (e.g., -vvv) to increase verbosity.
207
208       verbose_level
209              Level  of  debugging detail in output. Defaults to the number of
210              --verbose flags specified on the command line, or to 1  if  ver‐
211              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
212
213
214       debug_file
215              Write debug information to given file Obsoletes: debug
216
217       version
218              Display version information and exit
219
220       help   Display help and exit
221
222       plug_separator
223              Separator for plug parameter when specifying more  than  1  plug
224              (Default Value: ,)
225
226       separator
227              Separator for CSV created by 'list' operation (Default Value: ,)
228
229
230       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
231
232
233       disable_timeout
234              Disable  timeout (true/false) (default: true when run from Pace‐
235              maker 2.0+)
236
237       login_timeout
238              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
239
240
241       power_timeout
242              Test  X  seconds  for status change after ON/OFF (Default Value:
243              20)
244
245       power_wait
246              Wait X seconds after issuing ON/OFF (Default Value: 0)
247
248       shell_timeout
249              Wait X seconds for cmd prompt  after  issuing  command  (Default
250              Value: 3)
251
252       stonith_status_sleep
253              Sleep  X  seconds  between  status calls during a STONITH action
254              (Default Value: 1)
255
256       retry_on
257              Count of attempts to retry power on (Default Value: 1)
258
259       gnutlscli_path
260              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
261
262
263
264fence_vmware_soap (Fence Agent)   2009-10-20                    FENCE_AGENT(8)