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

ACTIONS

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

STDIN PARAMETERS

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