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.
16       Alternatively 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
33              always 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
52              machine 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       --retry-on=[attempts]
117              Count of attempts to retry power on (Default Value: 1)
118
119       --gnutlscli-path=[path]
120              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
121
122

ACTIONS

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

STDIN PARAMETERS

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