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

ACTIONS

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

STDIN PARAMETERS

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