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       -l, --username=[name]
37              Login name This parameter is always required.
38
39       --auth-url=[authurl]
40              Keystone Auth URL This  parameter  is  always  required.
41
42
43       --project-name=[project]
44              Keystone Project (Default Value: admin)
45
46       --user-domain-name=[domain]
47              Keystone User Domain Name (Default Value: Default)
48
49       --project-domain-name=[domain]
50              Keystone Project Domain Name (Default Value: Default)
51
52       --uuid=[uuid]
53              Replaced by port/-n/--plug
54
55       --cacert=[cacert]
56              SSL      X.509     certificates     file     (Default     Value:
57              /etc/pki/tls/certs/ca-bundle.crt)
58
59       --apitimeout=[seconds]
60              Timeout in seconds to use for API calls, default is 60. (Default
61              Value: 60)
62
63       -q, --quiet
64              Disable logging to stderr. Does not affect --verbose or --debug-
65              file or logging to syslog.
66
67       -v, --verbose
68              Verbose mode. Multiple -v flags can be stacked  on  the  command
69              line (e.g., -vvv) to increase verbosity.
70
71       --verbose-level
72              Level  of  debugging detail in output. Defaults to the number of
73              --verbose flags specified on the command line, or to 1  if  ver‐
74              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
75
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       -C, --separator=[char]
87              Separator for CSV created by 'list' operation (Default Value: ,)
88
89
90       --delay=[seconds]
91              Wait  X  seconds  before  fencing  is started (Default Value: 0)
92
93
94       --disable-timeout=[true/false]
95              Disable timeout (true/false) (default: true when run from  Pace‐
96              maker 2.0+)
97
98       --login-timeout=[seconds]
99              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
100
101
102       --power-timeout=[seconds]
103              Test X seconds for status change after  ON/OFF  (Default  Value:
104              60)
105
106       --power-wait=[seconds]
107              Wait X seconds after issuing ON/OFF (Default Value: 0)
108
109       --shell-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after issuing command (Default
111              Value: 3)
112
113       --stonith-status-sleep=[seconds]
114              Sleep X seconds between status calls  during  a  STONITH  action
115              (Default Value: 1)
116
117       --retry-on=[attempts]
118              Count of attempts to retry power on (Default Value: 1)
119
120

ACTIONS

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

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       password
159              Login password or passphrase Obsoletes: passwd
160
161       password_script
162              Script to run  to  retrieve  password  Obsoletes:  passwd_script
163
164
165       plug   UUID of the node to be fenced. Obsoletes: port
166
167       username
168              Login  name  This parameter is always required. Obsoletes: login
169
170
171       auth_url
172              Keystone Auth URL This parameter is always required.  Obsoletes:
173              auth-url
174
175       project_name
176              Keystone  Project (Default Value: admin) Obsoletes: project-name
177
178
179       user_domain_name
180              Keystone User Domain Name (Default  Value:  Default)  Obsoletes:
181              user-domain-name
182
183       project_domain_name
184              Keystone Project Domain Name (Default Value: Default) Obsoletes:
185              project-domain-name
186
187       uuid   Replaced by port/-n/--plug
188
189       cacert SSL     X.509     certificates     file     (Default      Value:
190              /etc/pki/tls/certs/ca-bundle.crt)
191
192       apitimeout
193              Timeout in seconds to use for API calls, default is 60. (Default
194              Value: 60)
195
196       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
197              file or logging to syslog.
198
199       verbose
200              Verbose  mode.  Multiple  -v flags can be stacked on the command
201              line (e.g., -vvv) to increase verbosity.
202
203       verbose_level
204              Level of debugging detail in output. Defaults to the  number  of
205              --verbose  flags  specified on the command line, or to 1 if ver‐
206              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
207
208
209       debug_file
210              Write debug information to given file Obsoletes: debug
211
212       version
213              Display version information and exit
214
215       help   Display help and exit
216
217       separator
218              Separator for CSV created by 'list' operation (Default Value: ,)
219
220
221       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
222
223
224       disable_timeout
225              Disable  timeout (true/false) (default: true when run from Pace‐
226              maker 2.0+)
227
228       login_timeout
229              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
230
231
232       power_timeout
233              Test  X  seconds  for status change after ON/OFF (Default Value:
234              60)
235
236       power_wait
237              Wait X seconds after issuing ON/OFF (Default Value: 0)
238
239       shell_timeout
240              Wait X seconds for cmd prompt  after  issuing  command  (Default
241              Value: 3)
242
243       stonith_status_sleep
244              Sleep  X  seconds  between  status calls during a STONITH action
245              (Default Value: 1)
246
247       retry_on
248              Count of attempts to retry power on (Default Value: 1)
249
250
251
252fence_openstack (Fence Agent)     2009-10-20                    FENCE_AGENT(8)