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       -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       --use-cookies
65              Reuse cookies for authentication
66
67       -l, --username=[name]
68              Login name This parameter is always required.
69
70       --api-version
71              Version of RHEV API (default: auto) (Default Value: auto)
72
73       --api-path=[path]
74              The path part of the API URL (Default Value:  /ovirt-engine/api)
75
76
77       --disable-http-filter
78              Set HTTP Filter header to false
79
80       -q, --quiet
81              Disable logging to stderr. Does not affect --verbose or --debug-
82              file or logging to syslog.
83
84       -v, --verbose
85              Verbose mode
86
87       -D, --debug-file=[debugfile]
88              Write debug information to given file
89
90       -V, --version
91              Display version information and exit
92
93       -h, --help
94              Display help and exit
95
96       -C, --separator=[char]
97              Separator for CSV created by 'list' operation (Default Value: ,)
98
99
100       --delay=[seconds]
101              Wait  X  seconds  before  fencing  is started (Default Value: 0)
102
103
104       --login-timeout=[seconds]
105              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
106
107
108       --power-timeout=[seconds]
109              Test  X  seconds  for status change after ON/OFF (Default Value:
110              20)
111
112       --power-wait=[seconds]
113              Wait X seconds after issuing ON/OFF (Default Value: 1)
114
115       --shell-timeout=[seconds]
116              Wait X seconds for cmd prompt  after  issuing  command  (Default
117              Value: 5)
118
119       --retry-on=[attempts]
120              Count of attempts to retry power on (Default Value: 1)
121
122       --gnutlscli-path=[path]
123              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
124
125

ACTIONS

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

STDIN PARAMETERS

159
160
161       action Fencing action (Default Value: reboot)
162
163       inet4_only
164              Forces agent to use IPv4 addresses only
165
166       inet6_only
167              Forces agent to use IPv6 addresses only
168
169       ip     IP address or hostname  of  fencing  device  This  parameter  is
170              always required. Obsoletes: ipaddr
171
172       ipport TCP/UDP  port  to use for connection with device (Default Value:
173              80)
174
175       notls  Disable TLS negotiation and force SSL3.0. This  should  only  be
176              used for devices that do not support TLS1.0 and up.
177
178
179       password
180              Login password or passphrase Obsoletes: passwd
181
182       password_script
183              Script to run  to  retrieve  password  Obsoletes:  passwd_script
184
185
186       plug   Physical  plug  number  on  device,  UUID  or  identification of
187              machine This parameter is always required. Obsoletes: port
188
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       api_path
209              The path part of the API URL (Default Value:  /ovirt-engine/api)
210
211
212       disable_http_filter
213              Set HTTP Filter header to false
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose mode
220
221       debug_file
222              Write debug information to given file Obsoletes: debug
223
224       version
225              Display version information and exit
226
227       help   Display help and exit
228
229       separator
230              Separator for CSV created by 'list' operation (Default Value: ,)
231
232
233       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
234
235
236       login_timeout
237              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
238
239
240       power_timeout
241              Test  X  seconds  for status change after ON/OFF (Default Value:
242              20)
243
244       power_wait
245              Wait X seconds after issuing ON/OFF (Default Value: 1)
246
247       shell_timeout
248              Wait X seconds for cmd prompt  after  issuing  command  (Default
249              Value: 5)
250
251       retry_on
252              Count of attempts to retry power on (Default Value: 1)
253
254       gnutlscli_path
255              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
256
257
258
259fence_rhevm (Fence Agent)         2009-10-20                    FENCE_AGENT(8)