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

ACTIONS

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

STDIN PARAMETERS

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