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

ACTIONS

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

STDIN PARAMETERS

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