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

NAME

7       fence_evacuate  -  Fence  agent for the automatic resurrection of Open‐
8       Stack compute instances
9

DESCRIPTION

11       Used to reschedule flagged instances
12
13       fence_evacuate accepts options on the command  line  as  well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_evacuate 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:
19

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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