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
42              machine 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       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132

ACTIONS

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

STDIN PARAMETERS

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