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

NAME

7       fence_ironic - Fence agent for OpenStack's Ironic (Bare Metal as a ser‐
8       vice) service
9

DESCRIPTION

11       fence_ironic is a Fencing agent which can be used  with  machines  con‐
12       trolled  by  the  Ironic  service.  This agent calls the openstack CLI.
13       WARNING! This fence agent is not intended for production  use.  Relying
14       on a functional ironic service for fencing is not a good design choice.
15
16       fence_ironic accepts options on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_ironic  can  be run by itself with command line options.  This is
19       useful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: https://wiki.openstack.org/wiki/Ironic
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       --auth-url=[authurl]
30              Keystone Admin Auth  URL  This  parameter  is  always  required.
31
32
33       -p, --password=[password]
34              Login password or passphrase
35
36       -S, --password-script=[script]
37              Script to run to retrieve password
38
39       -n, --plug=[id]
40              Physical  plug  number  on device, UUID or identification of ma‐
41              chine This parameter is always required.
42
43       -t, --tenant-name=[tenant]
44              Keystone Admin Tenant (Default Value: admin)
45
46       -l, --username=[name]
47              Login name This parameter is always required.
48
49       -q, --quiet
50              Disable logging to stderr. Does not affect --verbose or --debug-
51              file or logging to syslog.
52
53       -v, --verbose
54              Verbose  mode.  Multiple  -v flags can be stacked on the command
55              line (e.g., -vvv) to increase verbosity.
56
57       --verbose-level
58              Level of debugging detail in output. Defaults to the  number  of
59              --verbose  flags  specified on the command line, or to 1 if ver‐
60              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
61
62
63       -D, --debug-file=[debugfile]
64              Write debug information to given file
65
66       -V, --version
67              Display version information and exit
68
69       -h, --help
70              Display help and exit
71
72       --plug-separator=[char]
73              Separator  for  plug  parameter when specifying more than 1 plug
74              (Default Value: ,)
75
76       -C, --separator=[char]
77              Separator for CSV created by 'list' operation (Default Value: ,)
78
79
80       --delay=[seconds]
81              Wait  X  seconds  before  fencing  is started (Default Value: 0)
82
83
84       --disable-timeout=[true/false]
85              Disable timeout (true/false) (default: true when run from  Pace‐
86              maker 2.0+)
87
88       --login-timeout=[seconds]
89              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
90
91
92       --openstack-path=[path]
93              Path to the OpenStack binary (Default Value: /usr/bin/openstack)
94
95
96       --power-timeout=[seconds]
97              Test  X  seconds  for status change after ON/OFF (Default Value:
98              20)
99
100       --power-wait=[seconds]
101              Wait X seconds after issuing ON/OFF (Default Value: 0)
102
103       --shell-timeout=[seconds]
104              Wait X seconds for cmd prompt  after  issuing  command  (Default
105              Value: 3)
106
107       --stonith-status-sleep=[seconds]
108              Sleep  X  seconds  between  status calls during a STONITH action
109              (Default Value: 1)
110
111       --retry-on=[attempts]
112              Count of attempts to retry power on (Default Value: 1)
113
114

ACTIONS

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

STDIN PARAMETERS

148
149
150       action Fencing action (Default Value: reboot)
151
152       auth_url
153              Keystone Admin Auth URL This parameter is always required. Obso‐
154              letes: auth-url
155
156       password
157              Login password or passphrase Obsoletes: passwd
158
159       password_script
160              Script to run  to  retrieve  password  Obsoletes:  passwd_script
161
162
163       plug   Physical  plug  number  on device, UUID or identification of ma‐
164              chine This parameter is always required. Obsoletes:  port
165
166
167       tenant_name
168              Keystone  Admin Tenant (Default Value: admin) Obsoletes: tenant-
169              name
170
171       username
172              Login name This parameter is always required.  Obsoletes:  login
173
174
175       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
176              file or logging to syslog.
177
178       verbose
179              Verbose mode. Multiple -v flags can be stacked  on  the  command
180              line (e.g., -vvv) to increase verbosity.
181
182       verbose_level
183              Level  of  debugging detail in output. Defaults to the number of
184              --verbose flags specified on the command line, or to 1  if  ver‐
185              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
186
187
188       debug_file
189              Write debug information to given file Obsoletes: debug
190
191       version
192              Display version information and exit
193
194       help   Display help and exit
195
196       plug_separator
197              Separator for plug parameter when specifying more  than  1  plug
198              (Default Value: ,)
199
200       separator
201              Separator for CSV created by 'list' operation (Default Value: ,)
202
203
204       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
205
206
207       disable_timeout
208              Disable  timeout (true/false) (default: true when run from Pace‐
209              maker 2.0+)
210
211       login_timeout
212              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
213
214
215       openstack_path
216              Path to the OpenStack binary (Default Value: /usr/bin/openstack)
217              Obsoletes: openstack-path
218
219       power_timeout
220              Test X seconds for status change after  ON/OFF  (Default  Value:
221              20)
222
223       power_wait
224              Wait X seconds after issuing ON/OFF (Default Value: 0)
225
226       shell_timeout
227              Wait  X  seconds  for  cmd prompt after issuing command (Default
228              Value: 3)
229
230       stonith_status_sleep
231              Sleep X seconds between status calls  during  a  STONITH  action
232              (Default Value: 1)
233
234       retry_on
235              Count of attempts to retry power on (Default Value: 1)
236
237
238
239fence_ironic (Fence Agent)        2009-10-20                    FENCE_AGENT(8)