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       -4, --inet4-only
32              Forces agent to use IPv4 addresses only
33
34       -6, --inet6-only
35              Forces agent to use IPv6 addresses only
36
37       -a, --ip=[ip]
38              IP address or hostname  of  fencing  device  This  parameter  is
39              always required.
40
41       -u, --ipport=[port]
42              TCP/UDP  port  to use for connection with device (Default Value:
43              80)
44
45       -t, --notls
46              Disable TLS negotiation and force SSL3.0. This  should  only  be
47              used for devices that do not support TLS1.0 and up.
48
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to run to retrieve password
55
56       -n, --plug=[id]
57              Physical plug  number  on  device,  UUID  or  identification  of
58              machine This parameter is always required.
59
60       -z, --ssl
61              Use SSL connection with verifying certificate
62
63       --ssl-insecure
64              Use SSL connection without verifying certificate
65
66       --ssl-secure
67              Use SSL connection with verifying certificate
68
69       -l, --username=[name]
70              Login name This parameter is always required.
71
72       -q, --quiet
73              Disable logging to stderr. Does not affect --verbose or --debug-
74              file or logging to syslog.
75
76       -v, --verbose
77              Verbose mode
78
79       -D, --debug-file=[debugfile]
80              Write debug information to given file
81
82       -V, --version
83              Display version information and exit
84
85       -h, --help
86              Display help and exit
87
88       -C, --separator=[char]
89              Separator for CSV created by 'list' operation (Default Value: ,)
90
91
92       --delay=[seconds]
93              Wait  X  seconds  before  fencing  is started (Default Value: 0)
94
95
96       --login-timeout=[seconds]
97              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
98
99
100       --power-timeout=[seconds]
101              Test  X  seconds  for status change after ON/OFF (Default Value:
102              20)
103
104       --power-wait=[seconds]
105              Wait X seconds after issuing ON/OFF (Default Value: 0)
106
107       --shell-timeout=[seconds]
108              Wait X seconds for cmd prompt  after  issuing  command  (Default
109              Value: 3)
110
111       --retry-on=[attempts]
112              Count of attempts to retry power on (Default Value: 1)
113
114       --gnutlscli-path=[path]
115              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
116
117

ACTIONS

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

STDIN PARAMETERS

151
152
153       action Fencing action (Default Value: reboot)
154
155       inet4_only
156              Forces agent to use IPv4 addresses only
157
158       inet6_only
159              Forces agent to use IPv6 addresses only
160
161       ip     IP address or hostname  of  fencing  device  This  parameter  is
162              always required. Obsoletes: ipaddr
163
164       ipport TCP/UDP  port  to use for connection with device (Default Value:
165              80)
166
167       notls  Disable TLS negotiation and force SSL3.0. This  should  only  be
168              used for devices that do not support TLS1.0 and up.
169
170
171       password
172              Login password or passphrase Obsoletes: passwd
173
174       password_script
175              Script to run  to  retrieve  password  Obsoletes:  passwd_script
176
177
178       plug   Physical  plug  number  on  device,  UUID  or  identification of
179              machine This parameter is always required. Obsoletes: port
180
181
182       ssl    Use SSL connection with verifying certificate
183
184       ssl_insecure
185              Use SSL connection without verifying certificate
186
187       ssl_secure
188              Use SSL connection with verifying certificate
189
190       username
191              Login  name  This parameter is always required. Obsoletes: login
192
193
194       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
195              file or logging to syslog.
196
197       verbose
198              Verbose mode
199
200       debug_file
201              Write debug information to given file Obsoletes: debug
202
203       version
204              Display version information and exit
205
206       help   Display help and exit
207
208       separator
209              Separator for CSV created by 'list' operation (Default Value: ,)
210
211
212       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
213
214
215       login_timeout
216              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
217
218
219       power_timeout
220              Test X seconds for status change after  ON/OFF  (Default  Value:
221              20)
222
223       power_wait
224              Wait X seconds after issuing ON/OFF (Default Value: 0)
225
226       shell_timeout
227              Wait  X  seconds  for  cmd prompt after issuing command (Default
228              Value: 3)
229
230       retry_on
231              Count of attempts to retry power on (Default Value: 1)
232
233       gnutlscli_path
234              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
235
236
237
238fence_vmware_soap (Fence Agent)   2009-10-20                    FENCE_AGENT(8)