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

NAME

7       fence_rhevm - Fence agent for RHEV-M REST API
8

DESCRIPTION

10       fence_rhevm  is an I/O Fencing agent which can be used with RHEV-M REST
11       API to fence virtual machines.
12
13       fence_rhevm accepts options on the command line as well as from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_rhevm can be run by itself with command line  options.   This  is
16       useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.redhat.com
19

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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