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

ACTIONS

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

STDIN PARAMETERS

150
151
152       action Fencing action (Default Value: reboot)
153
154       inet4_only
155              Forces agent to use IPv4 addresses only
156
157       inet6_only
158              Forces agent to use IPv6 addresses only
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       api_path
194              The path part of the API URL (Default Value: /api)
195
196       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
197              file or logging to syslog.
198
199       verbose
200              Verbose mode
201
202       debug_file
203              Write debug information to given file Obsoletes: debug
204
205       version
206              Display version information and exit
207
208       help   Display help and exit
209
210       separator
211              Separator for CSV created by 'list' operation (Default Value: ,)
212
213
214       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
215
216
217       login_timeout
218              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
219
220
221       power_timeout
222              Test X seconds for status change after  ON/OFF  (Default  Value:
223              20)
224
225       power_wait
226              Wait X seconds after issuing ON/OFF (Default Value: 1)
227
228       shell_timeout
229              Wait  X  seconds  for  cmd prompt after issuing command (Default
230              Value: 5)
231
232       retry_on
233              Count of attempts to retry power on (Default Value: 1)
234
235       gnutlscli_path
236              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
237
238
239
240fence_vmware_vcloud (Fence Agent) 2009-10-20                    FENCE_AGENT(8)