1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_compute - Fence agent for the automatic resurrection of OpenStack
8       compute instances
9

DESCRIPTION

11       Used to tell Nova that compute nodes are down and to reschedule flagged
12       instances
13
14       fence_compute  accepts  options  on  the  command  line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_compute  can be run by itself with command line options.  This is
17       useful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL:
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: off)
26
27       -k, --auth-url=[url]
28              Keystone Admin Auth URL (Default Value: )
29
30       -e, --endpoint-type=[endpoint]
31              Nova Endpoint type  (Default  Value:  internalURL)
32
33
34       -p, --password=[password]
35              Login password or passphrase
36
37       -S, --password-script=[script]
38              Script to run to retrieve password
39
40       -n, --plug=[id]
41              Physical  plug  number  on device, UUID or identification of ma‐
42              chine This parameter is always required.
43
44       --region-name=[region]
45              Region Name (Default Value: )
46
47       -t, --tenant-name=[name]
48              Keystone Admin Tenant or v3 Project (Default Value: )
49
50       -l, --username=[name]
51              Login name
52
53       --insecure
54              Allow Insecure TLS Requests
55
56       -P, --project-domain=[name]
57              Keystone v3 Project Domain (Default Value: Default)
58
59       -u, --user-domain=[name]
60              Keystone v3 User Domain (Default Value: Default)
61
62       -d, --domain=[string]
63              DNS domain in which hosts live
64
65       --instance-filtering
66              Allow instances to be evacuated (Default Value: True)
67
68       --no-shared-storage
69              Disable functionality for dealing with shared  storage  (Default
70              Value: False)
71
72       --record-only
73              Only  record  the  target  as needing evacuation (Default Value:
74              False)
75
76       --compute-domain=[string]
77              Replaced by domain
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.  Multiple  -v flags can be stacked on the command
85              line (e.g., -vvv) to increase verbosity.
86
87       --verbose-level
88              Level of debugging detail in output. Defaults to the  number  of
89              --verbose  flags  specified on the command line, or to 1 if ver‐
90              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
91
92
93       -D, --debug-file=[debugfile]
94              Write debug information to given file
95
96       -V, --version
97              Display version information and exit
98
99       -h, --help
100              Display help and exit
101
102       --plug-separator=[char]
103              Separator  for  plug  parameter when specifying more than 1 plug
104              (Default Value: ,)
105
106       -C, --separator=[char]
107              Separator for CSV created by 'list' operation (Default Value: ,)
108
109
110       --delay=[seconds]
111              Wait  X  seconds  before  fencing  is started (Default Value: 0)
112
113
114       --disable-timeout=[true/false]
115              Disable timeout (true/false) (default: true when run from  Pace‐
116              maker 2.0+)
117
118       --login-timeout=[seconds]
119              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
120
121
122       --power-timeout=[seconds]
123              Test X seconds for status change after  ON/OFF  (Default  Value:
124              20)
125
126       --power-wait=[seconds]
127              Wait X seconds after issuing ON/OFF (Default Value: 0)
128
129       --shell-timeout=[seconds]
130              Wait  X  seconds  for  cmd prompt after issuing command (Default
131              Value: 180)
132
133       --stonith-status-sleep=[seconds]
134              Sleep X seconds between status calls  during  a  STONITH  action
135              (Default Value: 1)
136
137       --retry-on=[attempts]
138              Count of attempts to retry power on (Default Value: 1)
139
140

ACTIONS

142
143
144       on     Power on machine.
145
146       off    Power off machine.
147
148       status This returns the status of the plug/virtual machine.
149
150       list   List  available  plugs with aliases/virtual machines if there is
151              support for more then one device. Returns N/A otherwise.
152
153       list-status
154              List available plugs with  aliases/virtual  machines  and  their
155              power  state  if it can be obtained without additional commands.
156
157
158       monitor
159              Check the health of fence device
160
161       metadata
162              Display the XML metadata describing this resource.
163
164       manpage
165               The operational behavior of this is not known.
166
167       validate-all
168              Validate if all required parameters are entered.
169
170

STDIN PARAMETERS

172
173
174       action Fencing action (Default Value: off)
175
176       auth_url
177              Keystone Admin Auth URL (Default Value: )
178
179       endpoint_type
180              Nova Endpoint type  (Default  Value:  internalURL)
181
182
183       password
184              Login password or passphrase Obsoletes: passwd
185
186       password_script
187              Script  to  run  to  retrieve  password Obsoletes: passwd_script
188
189
190       plug   Physical plug number on device, UUID or  identification  of  ma‐
191              chine  This  parameter is always required. Obsoletes: port
192
193
194       region_name
195              Region Name (Default Value: )
196
197       tenant_name
198              Keystone Admin Tenant or v3 Project (Default Value: )
199
200       username
201              Login name Obsoletes: login
202
203       insecure
204              Allow Insecure TLS Requests
205
206       project_domain
207              Keystone v3 Project Domain (Default Value:  Default)  Obsoletes:
208              project-domain
209
210       user_domain
211              Keystone  v3  User  Domain  (Default  Value: Default) Obsoletes:
212              user-domain
213
214       domain DNS domain in which hosts live
215
216       instance_filtering
217              Allow instances to be evacuated (Default Value: True)
218
219       no_shared_storage
220              Disable functionality for dealing with shared  storage  (Default
221              Value: False)
222
223       record_only
224              Only  record  the  target  as needing evacuation (Default Value:
225              False)
226
227       compute_domain
228              Replaced by domain Obsoletes: compute-domain
229
230       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
231              file or logging to syslog.
232
233       verbose
234              Verbose  mode.  Multiple  -v flags can be stacked on the command
235              line (e.g., -vvv) to increase verbosity.
236
237       verbose_level
238              Level of debugging detail in output. Defaults to the  number  of
239              --verbose  flags  specified on the command line, or to 1 if ver‐
240              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
241
242
243       debug_file
244              Write debug information to given file Obsoletes: debug
245
246       version
247              Display version information and exit
248
249       help   Display help and exit
250
251       plug_separator
252              Separator  for  plug  parameter when specifying more than 1 plug
253              (Default Value: ,)
254
255       separator
256              Separator for CSV created by 'list' operation (Default Value: ,)
257
258
259       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
260
261
262       disable_timeout
263              Disable timeout (true/false) (default: true when run from  Pace‐
264              maker 2.0+)
265
266       login_timeout
267              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
268
269
270       power_timeout
271              Test X seconds for status change after  ON/OFF  (Default  Value:
272              20)
273
274       power_wait
275              Wait X seconds after issuing ON/OFF (Default Value: 0)
276
277       shell_timeout
278              Wait  X  seconds  for  cmd prompt after issuing command (Default
279              Value: 180)
280
281       stonith_status_sleep
282              Sleep X seconds between status calls  during  a  STONITH  action
283              (Default Value: 1)
284
285       retry_on
286              Count of attempts to retry power on (Default Value: 1)
287
288
289
290fence_compute (Fence Agent)       2009-10-20                    FENCE_AGENT(8)