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

ACTIONS

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

STDIN PARAMETERS

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