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
41              machine 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       --retry-on=[attempts]
104              Count of attempts to retry power on (Default Value: 1)
105
106

ACTIONS

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

STDIN PARAMETERS

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