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       -C, --separator=[char]
90              Separator for CSV created by 'list' operation (Default Value: ,)
91
92
93       --delay=[seconds]
94              Wait  X  seconds  before  fencing  is started (Default Value: 0)
95
96
97       --disable-timeout=[true/false]
98              Disable timeout (true/false) (default: true when run from  Pace‐
99              maker 2.0+)
100
101       --login-timeout=[seconds]
102              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
103
104
105       --power-timeout=[seconds]
106              Test X seconds for status change after  ON/OFF  (Default  Value:
107              20)
108
109       --power-wait=[seconds]
110              Wait X seconds after issuing ON/OFF (Default Value: 0)
111
112       --shell-timeout=[seconds]
113              Wait  X  seconds  for  cmd prompt after issuing command (Default
114              Value: 3)
115
116       --stonith-status-sleep=[seconds]
117              Sleep X seconds between status calls  during  a  STONITH  action
118              (Default Value: 1)
119
120       --retry-on=[attempts]
121              Count of attempts to retry power on (Default Value: 1)
122
123       --gnutlscli-path=[path]
124              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
125
126

ACTIONS

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