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 (Default Value: False)
55
56       -d, --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
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait X seconds before fencing  is  started  (Default  Value:  0)
101
102
103       --login-timeout=[seconds]
104              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
105
106
107       --power-timeout=[seconds]
108              Test X seconds for status change after  ON/OFF  (Default  Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait  X  seconds  for  cmd prompt after issuing command (Default
116              Value: 180)
117
118       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121

ACTIONS

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

STDIN PARAMETERS

153
154
155       action Fencing action (Default Value: off)
156
157       auth_url
158              Keystone Admin Auth URL (Default Value: )
159
160       endpoint_type
161              Nova  Endpoint  type  (Default  Value:  internalURL)
162
163
164       password
165              Login password or passphrase Obsoletes: passwd
166
167       password_script
168              Script to run  to  retrieve  password  Obsoletes:  passwd_script
169
170
171       plug   Physical  plug  number  on  device,  UUID  or  identification of
172              machine This parameter is always required. Obsoletes: port
173
174
175       region_name
176              Region Name (Default Value: )
177
178       tenant_name
179              Keystone Admin Tenant or v3 Project (Default Value: )
180
181       username
182              Login name Obsoletes: login
183
184       insecure
185              Allow Insecure TLS Requests (Default Value: False)
186
187       project_domain
188              Keystone  v3  Project Domain (Default Value: Default) Obsoletes:
189              project-domain
190
191       user_domain
192              Keystone v3 User  Domain  (Default  Value:  Default)  Obsoletes:
193              user-domain
194
195       domain DNS domain in which hosts live
196
197       instance_filtering
198              Allow instances to be evacuated (Default Value: True)
199
200       no_shared_storage
201              Disable  functionality  for dealing with shared storage (Default
202              Value: False)
203
204       record_only
205              Only record the target as  needing  evacuation  (Default  Value:
206              False)
207
208       compute_domain
209              Replaced by domain Obsoletes: compute-domain
210
211       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
212              file or logging to syslog.
213
214       verbose
215              Verbose mode
216
217       debug_file
218              Write debug information to given file Obsoletes: debug
219
220       version
221              Display version information and exit
222
223       help   Display help and exit
224
225       separator
226              Separator for CSV created by 'list' operation (Default Value: ,)
227
228
229       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
230
231
232       login_timeout
233              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
234
235
236       power_timeout
237              Test  X  seconds  for status change after ON/OFF (Default Value:
238              20)
239
240       power_wait
241              Wait X seconds after issuing ON/OFF (Default Value: 0)
242
243       shell_timeout
244              Wait X seconds for cmd prompt  after  issuing  command  (Default
245              Value: 180)
246
247       retry_on
248              Count of attempts to retry power on (Default Value: 1)
249
250
251
252fence_compute (Fence Agent)       2009-10-20                    FENCE_AGENT(8)