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
55
56       -D, --debug-file=[debugfile]
57              Write debug information to given file
58
59       -V, --version
60              Display version information and exit
61
62       -h, --help
63              Display help and exit
64
65       -C, --separator=[char]
66              Separator for CSV created by 'list' operation (Default Value: ,)
67
68
69       --delay=[seconds]
70              Wait X seconds before fencing  is  started  (Default  Value:  0)
71
72
73       --login-timeout=[seconds]
74              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
75
76
77       --openstack-path=[path]
78              Path to the OpenStack binary (Default Value: /usr/bin/openstack)
79
80
81       --power-timeout=[seconds]
82              Test  X  seconds  for status change after ON/OFF (Default Value:
83              20)
84
85       --power-wait=[seconds]
86              Wait X seconds after issuing ON/OFF (Default Value: 0)
87
88       --shell-timeout=[seconds]
89              Wait X seconds for cmd prompt  after  issuing  command  (Default
90              Value: 3)
91
92       --retry-on=[attempts]
93              Count of attempts to retry power on (Default Value: 1)
94
95

ACTIONS

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

STDIN PARAMETERS

129
130
131       action Fencing action (Default Value: reboot)
132
133       auth_url
134              Keystone Admin Auth URL This parameter is always required. Obso‐
135              letes: auth-url
136
137       password
138              Login password or passphrase Obsoletes: passwd
139
140       password_script
141              Script  to  run  to  retrieve  password Obsoletes: passwd_script
142
143
144       plug   Physical plug  number  on  device,  UUID  or  identification  of
145              machine This parameter is always required. Obsoletes: port
146
147
148       tenant_name
149              Keystone Admin Tenant (Default Value: admin) Obsoletes:  tenant-
150              name
151
152       username
153              Login  name  This parameter is always required. Obsoletes: login
154
155
156       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
157              file or logging to syslog.
158
159       verbose
160              Verbose mode
161
162       debug_file
163              Write debug information to given file Obsoletes: debug
164
165       version
166              Display version information and exit
167
168       help   Display help and exit
169
170       separator
171              Separator for CSV created by 'list' operation (Default Value: ,)
172
173
174       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
175
176
177       login_timeout
178              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
179
180
181       openstack_path
182              Path to the OpenStack binary (Default Value: /usr/bin/openstack)
183              Obsoletes: openstack-path
184
185       power_timeout
186              Test  X  seconds  for status change after ON/OFF (Default Value:
187              20)
188
189       power_wait
190              Wait X seconds after issuing ON/OFF (Default Value: 0)
191
192       shell_timeout
193              Wait X seconds for cmd prompt  after  issuing  command  (Default
194              Value: 3)
195
196       retry_on
197              Count of attempts to retry power on (Default Value: 1)
198
199
200
201fence_ironic (Fence Agent)        2009-10-20                    FENCE_AGENT(8)
Impressum