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       -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   VM name in RHV This parameter  is  always  required.  Obsoletes:
192              port
193
194       ssl    Use SSL connection with verifying certificate
195
196       ssl_insecure
197              Use SSL connection without verifying certificate
198
199       ssl_secure
200              Use SSL connection with verifying certificate
201
202       use_cookies
203              Reuse cookies for authentication
204
205       username
206              Login  name  This parameter is always required. Obsoletes: login
207
208
209       api_version
210              Version of RHEV API (default: auto) (Default Value: auto)
211
212       cookie_file
213              Path to cookie file for authentication
214
215       api_path
216              The path part of the API URL (Default Value:  /ovirt-engine/api)
217
218
219       disable_http_filter
220              Set HTTP Filter header to false
221
222       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
223              file or logging to syslog.
224
225       verbose
226              Verbose mode. Multiple -v flags can be stacked  on  the  command
227              line (e.g., -vvv) to increase verbosity.
228
229       verbose_level
230              Level  of  debugging detail in output. Defaults to the number of
231              --verbose flags specified on the command line, or to 1  if  ver‐
232              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
233
234
235       debug_file
236              Write debug information to given file Obsoletes: debug
237
238       version
239              Display version information and exit
240
241       help   Display help and exit
242
243       separator
244              Separator for CSV created by 'list' operation (Default Value: ,)
245
246
247       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
248
249
250       disable_timeout
251              Disable timeout (true/false) (default: true when run from  Pace‐
252              maker 2.0+)
253
254       login_timeout
255              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
256
257
258       power_timeout
259              Test X seconds for status change after  ON/OFF  (Default  Value:
260              20)
261
262       power_wait
263              Wait X seconds after issuing ON/OFF (Default Value: 1)
264
265       shell_timeout
266              Wait  X  seconds  for  cmd prompt after issuing command (Default
267              Value: 5)
268
269       stonith_status_sleep
270              Sleep X seconds between status calls  during  a  STONITH  action
271              (Default Value: 1)
272
273       retry_on
274              Count of attempts to retry power on (Default Value: 1)
275
276       gnutlscli_path
277              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
278
279
280
281fence_rhevm (Fence Agent)         2009-10-20                    FENCE_AGENT(8)