fence_vmware_vcloud(8)

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

ACTIONS

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

STDIN PARAMETERS

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