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       -C, --separator=[char]
73              Separator for CSV created by 'list' operation (Default Value: ,)
74
75
76       --delay=[seconds]
77              Wait X seconds before fencing  is  started  (Default  Value:  0)
78
79
80       --disable-timeout=[true/false]
81              Disable  timeout (true/false) (default: true when run from Pace‐
82              maker 2.0+)
83
84       --login-timeout=[seconds]
85              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
86
87
88       --openstack-path=[path]
89              Path to the OpenStack binary (Default Value: /usr/bin/openstack)
90
91
92       --power-timeout=[seconds]
93              Test X seconds for status change after  ON/OFF  (Default  Value:
94              20)
95
96       --power-wait=[seconds]
97              Wait X seconds after issuing ON/OFF (Default Value: 0)
98
99       --shell-timeout=[seconds]
100              Wait  X  seconds  for  cmd prompt after issuing command (Default
101              Value: 3)
102
103       --stonith-status-sleep=[seconds]
104              Sleep X seconds between status calls  during  a  STONITH  action
105              (Default Value: 1)
106
107       --retry-on=[attempts]
108              Count of attempts to retry power on (Default Value: 1)
109
110

ACTIONS

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

STDIN PARAMETERS

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