1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_openstack - Fence agent for OpenStack's Nova service
8

DESCRIPTION

10       fence_openstack is a Fencing agent which can be used with machines con‐
11       trolled by the Openstack's Nova service. This agent calls  the  python-
12       novaclient and it is mandatory to be installed
13
14       fence_openstack  accepts  options  on  the command line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_openstack  can  be run by itself with command line options.  This
17       is useful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL: https://wiki.openstack.org/wiki/Nova
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       -p, --password=[password]
28              Login password or passphrase
29
30       -S, --password-script=[script]
31              Script to run to retrieve password
32
33       -n, --plug=[UUID]
34              UUID of the node to be fenced.
35
36       --ssl-insecure
37              Use SSL connection without verifying certificate
38
39       -l, --username=[name]
40              Login name
41
42       --auth-url=[authurl]
43              Keystone Auth URL
44
45       --project-name=[project]
46              Keystone Project (Default Value: admin)
47
48       --user-domain-name=[domain]
49              Keystone User Domain Name (Default Value: Default)
50
51       --project-domain-name=[domain]
52              Keystone Project Domain Name (Default Value: Default)
53
54       --cloud=[cloud]
55              Cloud from clouds.yaml
56
57       --openrc=[openrc]
58              openrc config file
59
60       --uuid=[uuid]
61              Replaced by port/-n/--plug
62
63       --cacert=[cacert]
64              SSL X.509 certificates file (Default Value: )
65
66       --apitimeout=[seconds]
67              Timeout in seconds to use for API calls, default is 60. (Default
68              Value: 60)
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose mode. Multiple -v flags can be stacked  on  the  command
76              line (e.g., -vvv) to increase verbosity.
77
78       --verbose-level
79              Level  of  debugging detail in output. Defaults to the number of
80              --verbose flags specified on the command line, or to 1  if  ver‐
81              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
82
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       --plug-separator=[char]
94              Separator for plug parameter when specifying more  than  1  plug
95              (Default Value: ,)
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              60)
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: 3)
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       password
170              Login password or passphrase Obsoletes: passwd
171
172       password_script
173              Script  to  run  to  retrieve  password Obsoletes: passwd_script
174
175
176       plug   UUID of the node to be fenced. Obsoletes: port
177
178       ssl_insecure
179              Use SSL connection without verifying certificate
180
181       username
182              Login name Obsoletes: login
183
184       auth_url
185              Keystone Auth URL Obsoletes: auth-url
186
187       project_name
188              Keystone Project (Default Value: admin) Obsoletes:  project-name
189
190
191       user_domain_name
192              Keystone  User  Domain  Name (Default Value: Default) Obsoletes:
193              user-domain-name
194
195       project_domain_name
196              Keystone Project Domain Name (Default Value: Default) Obsoletes:
197              project-domain-name
198
199       cloud  Cloud from clouds.yaml
200
201       openrc openrc config file
202
203       uuid   Replaced by port/-n/--plug
204
205       cacert SSL X.509 certificates file (Default Value: )
206
207       apitimeout
208              Timeout in seconds to use for API calls, default is 60. (Default
209              Value: 60)
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.  Multiple  -v flags can be stacked on the command
216              line (e.g., -vvv) to increase verbosity.
217
218       verbose_level
219              Level of debugging detail in output. Defaults to the  number  of
220              --verbose  flags  specified on the command line, or to 1 if ver‐
221              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
222
223
224       debug_file
225              Write debug information to given file Obsoletes: debug
226
227       version
228              Display version information and exit
229
230       help   Display help and exit
231
232       plug_separator
233              Separator  for  plug  parameter when specifying more than 1 plug
234              (Default Value: ,)
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              60)
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: 3)
261
262       stonith_status_sleep
263              Sleep X seconds between status calls  during  a  STONITH  action
264              (Default Value: 1)
265
266       retry_on
267              Count of attempts to retry power on (Default Value: 1)
268
269
270
271fence_openstack (Fence Agent)     2009-10-20                    FENCE_AGENT(8)