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       --auth-url=[authurl]
28              Keystone Auth URL This  parameter  is  always  required.
29
30
31       -p, --password=[password]
32              Login password or passphrase
33
34       -S, --password-script=[script]
35              Script to run to retrieve password
36
37       -n, --plug=[UUID]
38              UUID of the node to be fenced.
39
40       --project-domain-name=[domain]
41              Keystone Project Domain Name (Default Value: Default)
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       -l, --username=[name]
50              Login name This parameter is always required.
51
52       --uuid=[uuid]
53              Replaced by port/-n/--plug
54
55       -q, --quiet
56              Disable logging to stderr. Does not affect --verbose or --debug-
57              file or logging to syslog.
58
59       -v, --verbose
60              Verbose mode. Multiple -v flags can be stacked  on  the  command
61              line (e.g., -vvv) to increase verbosity.
62
63       --verbose-level
64              Level  of  debugging detail in output. Defaults to the number of
65              --verbose flags specified on the command line, or to 1  if  ver‐
66              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
67
68
69       -D, --debug-file=[debugfile]
70              Write debug information to given file
71
72       -V, --version
73              Display version information and exit
74
75       -h, --help
76              Display help and exit
77
78       --delay=[seconds]
79              Wait X seconds before fencing  is  started  (Default  Value:  0)
80
81
82       --disable-timeout=[true/false]
83              Disable  timeout (true/false) (default: true when run from Pace‐
84              maker 2.0+)
85
86       --login-timeout=[seconds]
87              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
88
89
90       --power-timeout=[seconds]
91              Test  X  seconds  for status change after ON/OFF (Default Value:
92              20)
93
94       --power-wait=[seconds]
95              Wait X seconds after issuing ON/OFF (Default Value: 0)
96
97       --shell-timeout=[seconds]
98              Wait X seconds for cmd prompt  after  issuing  command  (Default
99              Value: 3)
100
101       --retry-on=[attempts]
102              Count of attempts to retry power on (Default Value: 1)
103
104

ACTIONS

106
107
108       on     Power on machine.
109
110       off    Power off machine.
111
112       reboot Reboot machine.
113
114       status This returns the status of the plug/virtual machine.
115
116       monitor
117              Check the health of fence device
118
119       metadata
120              Display the XML metadata describing this resource.
121
122       manpage
123               The operational behavior of this is not known.
124
125       validate-all
126              Validate if all required parameters are entered.
127
128

STDIN PARAMETERS

130
131
132       action Fencing action (Default Value: reboot)
133
134       auth_url
135              Keystone  Auth URL This parameter is always required. Obsoletes:
136              auth-url
137
138       password
139              Login password or passphrase Obsoletes: passwd
140
141       password_script
142              Script to run  to  retrieve  password  Obsoletes:  passwd_script
143
144
145       plug   UUID of the node to be fenced. Obsoletes: port
146
147
148       project_domain_name
149              Keystone Project Domain Name (Default Value: Default) Obsoletes:
150              project-domain-name
151
152       project_name
153              Keystone  Project (Default Value: admin) Obsoletes: project-name
154
155
156       user_domain_name
157              Keystone User Domain Name (Default  Value:  Default)  Obsoletes:
158              user-domain-name
159
160       username
161              Login  name  This parameter is always required. Obsoletes: login
162
163
164       uuid   Replaced by port/-n/--plug
165
166       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
167              file or logging to syslog.
168
169       verbose
170              Verbose  mode.  Multiple  -v flags can be stacked on the command
171              line (e.g., -vvv) to increase verbosity.
172
173       verbose_level
174              Level of debugging detail in output. Defaults to the  number  of
175              --verbose  flags  specified on the command line, or to 1 if ver‐
176              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
177
178
179       debug_file
180              Write debug information to given file Obsoletes: debug
181
182       version
183              Display version information and exit
184
185       help   Display help and exit
186
187       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
188
189
190       disable_timeout
191              Disable timeout (true/false) (default: true when run from  Pace‐
192              maker 2.0+)
193
194       login_timeout
195              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
196
197
198       power_timeout
199              Test X seconds for status change after  ON/OFF  (Default  Value:
200              20)
201
202       power_wait
203              Wait X seconds after issuing ON/OFF (Default Value: 0)
204
205       shell_timeout
206              Wait  X  seconds  for  cmd prompt after issuing command (Default
207              Value: 3)
208
209       retry_on
210              Count of attempts to retry power on (Default Value: 1)
211
212
213
214fence_openstack (Fence Agent)     2009-10-20                    FENCE_AGENT(8)