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       -4, --inet4-only
30              Forces agent to use IPv4 addresses only
31
32       -6, --inet6-only
33              Forces agent to use IPv6 addresses only
34
35       -a, --ip=[ip]
36              IP address or hostname  of  fencing  device  This  parameter  is
37              always required.
38
39       -u, --ipport=[port]
40              TCP/UDP  port  to use for connection with device (Default Value:
41              80)
42
43       -m, --method=[method]
44              Method to fence (onoff|cycle) (Default Value: onoff)
45
46       -n, --plug=[id]
47              Physical plug  number  on  device,  UUID  or  identification  of
48              machine This parameter is always required.
49
50       -z, --ssl
51              Use SSL connection with verifying certificate
52
53       --ssl-insecure
54              Use SSL connection without verifying certificate
55
56       --ssl-secure
57              Use SSL connection with verifying certificate
58
59       --api-version
60              Version  of  Docker  Remote  API (default: 1.11) (Default Value:
61              1.11)
62
63       --tlscacert
64              Path to CA certificate  (PEM  format)  for  TLS  authentication.
65              Required if --ssl option is used.
66
67       --tlscert
68              Path  to client certificate (PEM format) for TLS authentication.
69              Required if --ssl option is used.
70
71       --tlskey
72              Path to client key (PEM format) for TLS authentication. Required
73              if --ssl option is used.
74
75       -q, --quiet
76              Disable logging to stderr. Does not affect --verbose or --debug-
77              file or logging to syslog.
78
79       -v, --verbose
80              Verbose mode
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       -C, --separator=[char]
92              Separator for CSV created by 'list' operation (Default Value: ,)
93
94
95       --delay=[seconds]
96              Wait  X  seconds  before  fencing  is started (Default Value: 0)
97
98
99       --login-timeout=[seconds]
100              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
101
102
103       --power-timeout=[seconds]
104              Test  X  seconds  for status change after ON/OFF (Default Value:
105              20)
106
107       --power-wait=[seconds]
108              Wait X seconds after issuing ON/OFF (Default Value: 0)
109
110       --shell-timeout=[seconds]
111              Wait X seconds for cmd prompt  after  issuing  command  (Default
112              Value: 3)
113
114       --retry-on=[attempts]
115              Count of attempts to retry power on (Default Value: 1)
116
117       --gnutlscli-path=[path]
118              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
119
120

ACTIONS

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

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       inet4_only
159              Forces agent to use IPv4 addresses only
160
161       inet6_only
162              Forces agent to use IPv6 addresses only
163
164       ip     IP address or hostname  of  fencing  device  This  parameter  is
165              always required. Obsoletes: ipaddr
166
167       ipport TCP/UDP  port  to use for connection with device (Default Value:
168              80)
169
170       method Method to fence (onoff|cycle) (Default Value: onoff)
171
172       plug   Physical plug  number  on  device,  UUID  or  identification  of
173              machine This parameter is always required. Obsoletes: port
174
175
176       ssl    Use SSL connection with verifying certificate
177
178       ssl_insecure
179              Use SSL connection without verifying certificate
180
181       ssl_secure
182              Use SSL connection with verifying certificate
183
184       api_version
185              Version of Docker Remote API  (default:  1.11)  (Default  Value:
186              1.11)
187
188       tlscacert
189              Path  to  CA  certificate  (PEM  format) for TLS authentication.
190              Required if --ssl option is used.
191
192       tlscert
193              Path to client certificate (PEM format) for TLS  authentication.
194              Required if --ssl option is used.
195
196       tlskey Path to client key (PEM format) for TLS authentication. Required
197              if --ssl option is used.
198
199       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
200              file or logging to syslog.
201
202       verbose
203              Verbose mode
204
205       debug_file
206              Write debug information to given file Obsoletes: debug
207
208       version
209              Display version information and exit
210
211       help   Display help and exit
212
213       separator
214              Separator for CSV created by 'list' operation (Default Value: ,)
215
216
217       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
218
219
220       login_timeout
221              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
222
223
224       power_timeout
225              Test X seconds for status change after  ON/OFF  (Default  Value:
226              20)
227
228       power_wait
229              Wait X seconds after issuing ON/OFF (Default Value: 0)
230
231       shell_timeout
232              Wait  X  seconds  for  cmd prompt after issuing command (Default
233              Value: 3)
234
235       retry_on
236              Count of attempts to retry power on (Default Value: 1)
237
238       gnutlscli_path
239              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
240
241
242
243fence_docker (Fence Agent)        2009-10-20                    FENCE_AGENT(8)