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
28              always 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       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
128
129       --gnutlscli-path=[path]
130              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
131
132

ACTIONS

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

STDIN PARAMETERS

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