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              80)
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
46
47       --ssl-insecure
48              Use SSL connection without verifying certificate
49
50       --ssl-secure
51              Use SSL connection with verifying certificate
52
53       --api-version
54              Version  of  Docker  Remote  API (default: 1.11) (Default Value:
55              1.11)
56
57       --tlscacert
58              Path to CA certificate (PEM format) for TLS authentication.  Re‐
59              quired if --ssl option is used.
60
61       --tlscert
62              Path  to client certificate (PEM format) for TLS authentication.
63              Required if --ssl option is used.
64
65       --tlskey
66              Path to client key (PEM format) for TLS authentication. Required
67              if --ssl option is used.
68
69       -q, --quiet
70              Disable logging to stderr. Does not affect --verbose or --debug-
71              file or logging to syslog.
72
73       -v, --verbose
74              Verbose mode. Multiple -v flags can be stacked  on  the  command
75              line (e.g., -vvv) to increase verbosity.
76
77       --verbose-level
78              Level  of  debugging detail in output. Defaults to the number of
79              --verbose flags specified on the command line, or to 1  if  ver‐
80              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
81
82
83       -D, --debug-file=[debugfile]
84              Write debug information to given file
85
86       -V, --version
87              Display version information and exit
88
89       -h, --help
90              Display help and exit
91
92       -C, --separator=[char]
93              Separator for CSV created by 'list' operation (Default Value: ,)
94
95
96       --delay=[seconds]
97              Wait  X  seconds  before  fencing  is started (Default Value: 0)
98
99
100       --disable-timeout=[true/false]
101              Disable timeout (true/false) (default: true when run from  Pace‐
102              maker 2.0+)
103
104       --login-timeout=[seconds]
105              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
106
107
108       --power-timeout=[seconds]
109              Test X seconds for status change after  ON/OFF  (Default  Value:
110              20)
111
112       --power-wait=[seconds]
113              Wait X seconds after issuing ON/OFF (Default Value: 0)
114
115       --shell-timeout=[seconds]
116              Wait  X  seconds  for  cmd prompt after issuing command (Default
117              Value: 3)
118
119       --stonith-status-sleep=[seconds]
120              Sleep X seconds between status calls  during  a  STONITH  action
121              (Default Value: 1)
122
123       --retry-on=[attempts]
124              Count of attempts to retry power on (Default Value: 1)
125
126       --gnutlscli-path=[path]
127              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
128
129

ACTIONS

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

STDIN PARAMETERS

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