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
41              machine 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       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127

ACTIONS

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

STDIN PARAMETERS

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