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 This parameter is always required.
34
35       -u, --ipport=[port]
36              TCP/UDP  port  to use for connection with device (Default Value:
37              80)
38
39       -l, --username=[name]
40              Login Name This parameter is always required.
41
42       -t, --notls
43              Disable TLS negotiation, force SSL 3.0 (Default Value: 1)
44
45       -p, --password=[password]
46              Login password or passphrase
47
48       -S, --password-script=[script]
49              Script to retrieve password
50
51       -n, --plug=[id]
52              Physical plug number, name  of  virtual  machine  or  UUID  This
53              parameter is always required.
54
55       -z, --ssl
56              SSL connection
57
58       --ssl-insecure
59              SSL  connection  without  verifying  fence  device's certificate
60
61
62       --ssl-secure
63              SSL connection with verifying fence device's certificate
64
65       --use-cookies
66              Reuse cookies for authentication
67
68       --api-path=[path]
69              The path of the API URL (Default Value: /ovirt-engine/api)
70
71       --disable-http-filter
72              Set HTTP Filter header to false
73
74       -v, --verbose
75              Verbose mode
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       -C, --separator=[char]
87              Separator for CSV created by operation list (Default  Value:  ,)
88
89
90       --delay=[seconds]
91              Wait  X  seconds  before  fencing  is started (Default Value: 0)
92
93
94       --login-timeout=[seconds]
95              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
96
97
98       --power-timeout=[seconds]
99              Test  X  seconds  for status change after ON/OFF (Default Value:
100              20)
101
102       --power-wait=[seconds]
103              Wait X seconds after issuing ON/OFF (Default Value: 1)
104
105       --shell-timeout=[seconds]
106              Wait X seconds for cmd prompt  after  issuing  command  (Default
107              Value: 3)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112       --gnutlscli-path=[path]
113              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
114
115

ACTIONS

117
118
119       on     Power on machine.
120
121       off    Power off machine.
122
123       reboot Reboot machine.
124
125       status This returns the status of the plug/virtual machine.
126
127       list   List  available  plugs with aliases/virtual machines if there is
128              support for more then one device. Returns N/A otherwise.
129
130       list-status
131              List available plugs with  aliases/virtual  machines  and  their
132              power  state  if it can be obtained without additional commands.
133
134
135       monitor
136              Check the health of fence device
137
138       metadata
139              Display the XML metadata describing this resource.
140
141

STDIN PARAMETERS

143
144
145       action Fencing Action (Default Value: reboot)
146
147       inet4_only
148              Forces agent to use IPv4 addresses only
149
150       inet6_only
151              Forces agent to use IPv6 addresses only
152
153       ipaddr IP Address or Hostname This parameter is always required.
154
155       ipport TCP/UDP port to use for connection with device  (Default  Value:
156              80)
157
158       login  Login Name This parameter is always required.
159
160       notls  Disable TLS negotiation, force SSL 3.0 (Default Value: 1)
161
162       passwd Login password or passphrase
163
164       passwd_script
165              Script to retrieve password
166
167       port   Physical  plug  number,  name  of  virtual  machine or UUID This
168              parameter is always required.
169
170       ssl    SSL connection
171
172       ssl_insecure
173              SSL connection  without  verifying  fence  device's  certificate
174
175
176       ssl_secure
177              SSL connection with verifying fence device's certificate
178
179       use_cookies
180              Reuse cookies for authentication
181
182       api_path
183              The path of the API URL (Default Value: /ovirt-engine/api)
184
185       disable_http_filter
186              Set HTTP Filter header to false
187
188       verbose
189              Verbose mode
190
191       debug  Write debug information to given file
192
193       version
194              Display version information and exit
195
196       help   Display help and exit
197
198       separator
199              Separator  for  CSV created by operation list (Default Value: ,)
200
201
202       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
203
204
205       login_timeout
206              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
207
208
209       power_timeout
210              Test X seconds for status change after  ON/OFF  (Default  Value:
211              20)
212
213       power_wait
214              Wait X seconds after issuing ON/OFF (Default Value: 1)
215
216       shell_timeout
217              Wait  X  seconds  for  cmd prompt after issuing command (Default
218              Value: 3)
219
220       retry_on
221              Count of attempts to retry power on (Default Value: 1)
222
223       gnutlscli_path
224              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
225
226
227
228fence_rhevm (Fence Agent)         2009-10-20                    FENCE_AGENT(8)