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

NAME

7       fence_docker - Fence agent for Docker
8

DESCRIPTION

10       fence_docker is I/O fencing agent which can be used with the Docker En‐
11       gine containers. You can use this fence-agent without  any  authentica‐
12       tion,  or  you  can use TLS authentication (use --ssl option, more info
13       about  TLS  authentication  in   docker:   http://docs.docker.com/exam‐
14       ples/https/).
15
16       fence_docker accepts options on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_docker  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: www.docker.io
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -a, --ip=[ip]
30              IP address or hostname of fencing device This parameter  is  al‐
31              ways required.
32
33       -u, --ipport=[port]
34              TCP/UDP  port  to use for connection with device (Default Value:
35              443)
36
37       -m, --method=[method]
38              Method to fence (onoff|cycle) (Default Value: onoff)
39
40       -n, --plug=[id]
41              Physical plug number on device, UUID or  identification  of  ma‐
42              chine This parameter is always required.
43
44       -z, --ssl
45              Use SSL connection with verifying certificate (Default Value: 1)
46
47
48       --ssl-insecure
49              Use SSL connection without verifying certificate
50
51       --ssl-secure
52              Use SSL connection with verifying certificate
53
54       --api-version
55              Version of Docker Remote API  (default:  1.11)  (Default  Value:
56              1.11)
57
58       --tlscacert
59              Path  to CA certificate (PEM format) for TLS authentication. Re‐
60              quired if --ssl option is used.
61
62       --tlscert
63              Path to client certificate (PEM format) for TLS  authentication.
64              Required if --ssl option is used.
65
66       --tlskey
67              Path to client key (PEM format) for TLS authentication. Required
68              if --ssl option is used.
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose  mode.  Multiple  -v flags can be stacked on the command
76              line (e.g., -vvv) to increase verbosity.
77
78       --verbose-level
79              Level of debugging detail in output. Defaults to the  number  of
80              --verbose  flags  specified on the command line, or to 1 if ver‐
81              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
82
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       --plug-separator=[char]
94              Separator  for  plug  parameter when specifying more than 1 plug
95              (Default Value: ,)
96
97       -C, --separator=[char]
98              Separator for CSV created by 'list' operation (Default Value: ,)
99
100
101       --delay=[seconds]
102              Wait  X  seconds  before  fencing  is started (Default Value: 0)
103
104
105       --disable-timeout=[true/false]
106              Disable timeout (true/false) (default: true when run from  Pace‐
107              maker 2.0+)
108
109       --login-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
111
112
113       --power-timeout=[seconds]
114              Test X seconds for status change after  ON/OFF  (Default  Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 0)
119
120       --shell-timeout=[seconds]
121              Wait  X  seconds  for  cmd prompt after issuing command (Default
122              Value: 3)
123
124       --stonith-status-sleep=[seconds]
125              Sleep X seconds between status calls  during  a  STONITH  action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --gnutlscli-path=[path]
132              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
133
134

ACTIONS

136
137
138       on     Power on machine.
139
140       off    Power off machine.
141
142       reboot Reboot machine.
143
144       status This returns the status of the plug/virtual machine.
145
146       list   List  available  plugs with aliases/virtual machines if there is
147              support for more then one device. Returns N/A otherwise.
148
149       list-status
150              List available plugs with  aliases/virtual  machines  and  their
151              power  state  if it can be obtained without additional commands.
152
153
154       monitor
155              Check the health of fence device
156
157       metadata
158              Display the XML metadata describing this resource.
159
160       manpage
161               The operational behavior of this is not known.
162
163       validate-all
164              Validate if all required parameters are entered.
165
166

STDIN PARAMETERS

168
169
170       action Fencing action (Default Value: reboot)
171
172       ip     IP address or hostname of fencing device This parameter  is  al‐
173              ways required. Obsoletes: ipaddr
174
175       ipport TCP/UDP  port  to use for connection with device (Default Value:
176              443)
177
178       method Method to fence (onoff|cycle) (Default Value: onoff)
179
180       plug   Physical plug number on device, UUID or  identification  of  ma‐
181              chine  This  parameter is always required. Obsoletes: port
182
183
184       ssl    Use SSL connection with verifying certificate (Default Value: 1)
185
186
187       ssl_insecure
188              Use SSL connection without verifying certificate
189
190       ssl_secure
191              Use SSL connection with verifying certificate
192
193       api_version
194              Version  of  Docker  Remote  API (default: 1.11) (Default Value:
195              1.11)
196
197       tlscacert
198              Path to CA certificate (PEM format) for TLS authentication.  Re‐
199              quired if --ssl option is used.
200
201       tlscert
202              Path  to client certificate (PEM format) for TLS authentication.
203              Required if --ssl option is used.
204
205       tlskey Path to client key (PEM format) for TLS authentication. Required
206              if --ssl option is used.
207
208       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
209              file or logging to syslog.
210
211       verbose
212              Verbose mode. Multiple -v flags can be stacked  on  the  command
213              line (e.g., -vvv) to increase verbosity.
214
215       verbose_level
216              Level  of  debugging detail in output. Defaults to the number of
217              --verbose flags specified on the command line, or to 1  if  ver‐
218              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
219
220
221       debug_file
222              Write debug information to given file Obsoletes: debug
223
224       version
225              Display version information and exit
226
227       help   Display help and exit
228
229       plug_separator
230              Separator for plug parameter when specifying more  than  1  plug
231              (Default Value: ,)
232
233       separator
234              Separator for CSV created by 'list' operation (Default Value: ,)
235
236
237       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
238
239
240       disable_timeout
241              Disable  timeout (true/false) (default: true when run from Pace‐
242              maker 2.0+)
243
244       login_timeout
245              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
246
247
248       power_timeout
249              Test  X  seconds  for status change after ON/OFF (Default Value:
250              20)
251
252       power_wait
253              Wait X seconds after issuing ON/OFF (Default Value: 0)
254
255       shell_timeout
256              Wait X seconds for cmd prompt  after  issuing  command  (Default
257              Value: 3)
258
259       stonith_status_sleep
260              Sleep  X  seconds  between  status calls during a STONITH action
261              (Default Value: 1)
262
263       retry_on
264              Count of attempts to retry power on (Default Value: 1)
265
266       gnutlscli_path
267              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
268
269
270
271fence_docker (Fence Agent)        2009-10-20                    FENCE_AGENT(8)