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
11       Engine 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
31              always 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
42              machine 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.
59              Required 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       --retry-on=[attempts]
120              Count of attempts to retry power on (Default Value: 1)
121
122       --gnutlscli-path=[path]
123              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
124
125

ACTIONS

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

STDIN PARAMETERS

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