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-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
82
83       -D, --debug-file=[debugfile]
84              Write debug information to given file
85
86       -V, --version
87              Display version information and exit
88
89       -h, --help
90              Display help and exit
91
92       -C, --separator=[char]
93              Separator for CSV created by 'list' operation (Default Value: ,)
94
95
96       --delay=[seconds]
97              Wait X seconds before fencing  is  started  (Default  Value:  0)
98
99
100       --login-timeout=[seconds]
101              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
102
103
104       --power-timeout=[seconds]
105              Test X seconds for status change after  ON/OFF  (Default  Value:
106              20)
107
108       --power-wait=[seconds]
109              Wait X seconds after issuing ON/OFF (Default Value: 1)
110
111       --shell-timeout=[seconds]
112              Wait  X  seconds  for  cmd prompt after issuing command (Default
113              Value: 3)
114
115       --retry-on=[attempts]
116              Count of attempts to retry power on (Default Value: 1)
117
118       --gnutlscli-path=[path]
119              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
120
121

ACTIONS

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

STDIN PARAMETERS

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