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       -C, --separator=[char]
98              Separator for CSV created by 'list' operation (Default Value: ,)
99
100
101       --delay=[seconds]
102              Wait X seconds before fencing  is  started  (Default  Value:  0)
103
104
105       --disable-timeout=[true/false]
106              Disable  timeout (true/false) (default: true when run from Pace‐
107              maker 2.0+)
108
109       --login-timeout=[seconds]
110              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
111
112
113       --power-timeout=[seconds]
114              Test  X  seconds  for status change after ON/OFF (Default Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 0)
119
120       --shell-timeout=[seconds]
121              Wait X seconds for cmd prompt  after  issuing  command  (Default
122              Value: 180)
123
124       --stonith-status-sleep=[seconds]
125              Sleep  X  seconds  between  status calls during a STONITH action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131

ACTIONS

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

STDIN PARAMETERS

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