fence_vmware_rest(8)

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

NAME

7       fence_vmware_rest - Fence agent for VMware REST API
8

DESCRIPTION

10       fence_vmware_rest is an I/O Fencing agent which can be used with VMware
11       API to fence virtual machines.
12
13       NOTE: If there's more than 1000 VMs there is a filter parameter to work
14       around  the API limit. See https://code.vmware.com/apis/62/vcenter-man‐
15       agement#/VM%20/get_vcenter_vm for full list of filters.
16
17       fence_vmware_rest accepts options on the command line as well  as  from
18       stdin.  Fenced  sends parameters through stdin when it execs the agent.
19       fence_vmware_rest can be run by itself with command line options.  This
20       is useful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: https://www.vmware.com
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: reboot)
29
30       -a, --ip=[ip]
31              IP  address  or hostname of fencing device This parameter is al‐
32              ways required.
33
34       -u, --ipport=[port]
35              TCP/UDP port to use for connection with device  (Default  Value:
36              80)
37
38       -t, --notls
39              Disable  TLS  negotiation  and force SSL3.0. This should only be
40              used for devices that do not support TLS1.0 and up.
41
42
43       -p, --password=[password]
44              Login password or passphrase
45
46       -S, --password-script=[script]
47              Script to run to retrieve password
48
49       -n, --plug=[id]
50              Physical  plug  number  on device, UUID or identification of ma‐
51              chine This parameter is always required.
52
53       -z, --ssl
54              Use SSL connection with verifying certificate
55
56       --ssl-insecure
57              Use SSL connection without verifying certificate
58
59       --ssl-secure
60              Use SSL connection with verifying certificate
61
62       -l, --username=[name]
63              Login name This parameter is always required.
64
65       --api-path=[path]
66              The path part of the API URL (Default Value: /rest)
67
68       --filter=[filter]
69              Filter to only return relevant VMs. It can be used to avoid  the
70              agent failing when more than 1000 VMs should be returned.
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. Multiple -v flags can be stacked  on  the  command
78              line (e.g., -vvv) to increase verbosity.
79
80       --verbose-level
81              Level  of  debugging detail in output. Defaults to the number of
82              --verbose flags specified on the command line, or to 1  if  ver‐
83              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
84
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait  X  seconds  before  fencing  is started (Default Value: 0)
101
102
103       --disable-timeout=[true/false]
104              Disable timeout (true/false) (default: true when run from  Pace‐
105              maker 2.0+)
106
107       --login-timeout=[seconds]
108              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
109
110
111       --power-timeout=[seconds]
112              Test X seconds for status change after  ON/OFF  (Default  Value:
113              20)
114
115       --power-wait=[seconds]
116              Wait X seconds after issuing ON/OFF (Default Value: 1)
117
118       --shell-timeout=[seconds]
119              Wait  X  seconds  for  cmd prompt after issuing command (Default
120              Value: 5)
121
122       --stonith-status-sleep=[seconds]
123              Sleep X seconds between status calls  during  a  STONITH  action
124              (Default Value: 1)
125
126       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
128
129       --gnutlscli-path=[path]
130              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
131
132

ACTIONS

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

STDIN PARAMETERS

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