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

ACTIONS

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

STDIN PARAMETERS

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