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       fence_vmware_rest 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_rest can be run by itself with command line options.  This
16       is useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: https://www.vmware.com
19

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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