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

NAME

7       fence_vmware_vcloud - Fence agent for VMware vCloud Director API
8

DESCRIPTION

10       fence_vmware_vcloud  is  an  I/O  Fencing  agent which can be used with
11       VMware vCloud Director API to fence virtual machines.
12
13       fence_vmware_vcloud accepts options on the command line as well as from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_vmware_vcloud can be run by itself  with  command  line  options.
16       This  is  useful  for  testing  and  for turning outlets on or off from
17       scripts.
18
19       Vendor URL: https://www.vmware.com
20

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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