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
32              always 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
51              machine 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       --retry-on=[attempts]
123              Count of attempts to retry power on (Default Value: 1)
124
125       --gnutlscli-path=[path]
126              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
127
128

ACTIONS

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

STDIN PARAMETERS

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