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

NAME

7       fence_gce - Fence agent for GCE (Google Cloud Engine)
8

DESCRIPTION

10       fence_gce  is  an  I/O  Fencing agent for GCE (Google Cloud Engine). It
11       uses the googleapiclient library to connect  to  GCE.   googleapiclient
12       can  be configured with Google SDK CLI or by executing 'gcloud auth ap‐
13       plication-default      login'.        For       instructions       see:
14       https://cloud.google.com/compute/docs/tutorials/python-guide
15
16       fence_gce  accepts  options  on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_gce can be run by itself with command line options.  This is use‐
19       ful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://cloud.google.com
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -m, --method=[method]
30              Method to fence (onoff|cycle) (Default Value: cycle)
31
32       -n, --plug=[id]
33              Physical plug number on device, UUID or  identification  of  ma‐
34              chine This parameter is always required.
35
36       --zone=[name]
37              Zone.
38
39       --project=[name]
40              Project ID.
41
42       --stackdriver-logging
43              Stackdriver-logging support.
44
45       --baremetalsolution
46              If enabled this is a bare metal offering from google.
47
48       --apitimeout=[seconds]
49              Timeout in seconds to use for API calls, default is 60. (Default
50              Value: 60)
51
52       --retries=[retries]
53              Number of retries on failure for API calls, default is  3.  (De‐
54              fault Value: 3)
55
56       --retrysleep=[seconds]
57              Time to sleep in seconds between API retries, default is 5. (De‐
58              fault Value: 5)
59
60       --serviceaccount=[filename]
61              Service Account to use for authentication to  the  google  cloud
62              APIs.
63
64       --plugzonemap=[plugzonemap]
65              Comma separated zone map when fencing multiple plugs.
66
67       --proxyhost=[proxy_host]
68              If a proxy is used for internet access, the proxy host should be
69              specified.
70
71       --proxyport=[proxy_port]
72              If a proxy is used for internet access, the proxy port should be
73              specified.
74
75       --earlyexit
76              If an existing reset operation is detected, the fence agent will
77              return before the operation completes  with  a  0  return  code.
78
79
80       --warntimeout=[warn_timeout]
81              If  the operation is not completed within the timeout, the clus‐
82              ter operations are allowed to continue.
83
84       --errortimeout=[error_timeout]
85              If the operation is not completed within the timeout, cluster is
86              notified of the operation failure.
87
88       --runonwarn=[run_on_warn]
89              If  a timeout would occur while running the agent, then the sup‐
90              plied command is run.
91
92       --runonfail=[run_on_fail]
93              If a failure would occur while running the agent, then the  sup‐
94              plied command is run.
95
96       -q, --quiet
97              Disable logging to stderr. Does not affect --verbose or --debug-
98              file or logging to syslog.
99
100       -v, --verbose
101              Verbose mode. Multiple -v flags can be stacked  on  the  command
102              line (e.g., -vvv) to increase verbosity.
103
104       --verbose-level
105              Level  of  debugging detail in output. Defaults to the number of
106              --verbose flags specified on the command line, or to 1  if  ver‐
107              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
108
109
110       -D, --debug-file=[debugfile]
111              Write debug information to given file
112
113       -V, --version
114              Display version information and exit
115
116       -h, --help
117              Display help and exit
118
119       --plug-separator=[char]
120              Separator for plug parameter when specifying more  than  1  plug
121              (Default Value: ,)
122
123       -C, --separator=[char]
124              Separator for CSV created by 'list' operation (Default Value: ,)
125
126
127       --delay=[seconds]
128              Wait X seconds before fencing  is  started  (Default  Value:  0)
129
130
131       --disable-timeout=[true/false]
132              Disable  timeout (true/false) (default: true when run from Pace‐
133              maker 2.0+)
134
135       --login-timeout=[seconds]
136              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
137
138
139       --power-timeout=[seconds]
140              Test  X  seconds  for status change after ON/OFF (Default Value:
141              60)
142
143       --power-wait=[seconds]
144              Wait X seconds after issuing ON/OFF (Default Value: 0)
145
146       --shell-timeout=[seconds]
147              Wait X seconds for cmd prompt  after  issuing  command  (Default
148              Value: 3)
149
150       --stonith-status-sleep=[seconds]
151              Sleep  X  seconds  between  status calls during a STONITH action
152              (Default Value: 1)
153
154       --retry-on=[attempts]
155              Count of attempts to retry power on (Default Value: 1)
156
157

ACTIONS

159
160
161       on     Power on machine.
162
163       off    Power off machine.
164
165       reboot Reboot machine.
166
167       status This returns the status of the plug/virtual machine.
168
169       list   List available plugs with aliases/virtual machines if  there  is
170              support for more then one device. Returns N/A otherwise.
171
172       list-status
173              List  available  plugs  with  aliases/virtual machines and their
174              power state if it can be obtained without  additional  commands.
175
176
177       monitor
178              Check the health of fence device
179
180       metadata
181              Display the XML metadata describing this resource.
182
183       manpage
184               The operational behavior of this is not known.
185
186       validate-all
187              Validate if all required parameters are entered.
188
189

STDIN PARAMETERS

191
192
193       action Fencing action (Default Value: reboot)
194
195       method Method to fence (onoff|cycle) (Default Value: cycle)
196
197       plug   Physical  plug  number  on device, UUID or identification of ma‐
198              chine This parameter is always required. Obsoletes:  port
199
200
201       zone   Zone.
202
203       project
204              Project ID.
205
206       stackdriver_logging
207              Stackdriver-logging   support.   Obsoletes:  stackdriver-logging
208
209
210       baremetalsolution
211              If enabled this is a bare metal offering from google.
212
213       apitimeout
214              Timeout in seconds to use for API calls, default is 60. (Default
215              Value: 60)
216
217       retries
218              Number  of  retries on failure for API calls, default is 3. (De‐
219              fault Value: 3)
220
221       retrysleep
222              Time to sleep in seconds between API retries, default is 5. (De‐
223              fault Value: 5)
224
225       serviceaccount
226              Service  Account  to  use for authentication to the google cloud
227              APIs.
228
229       plugzonemap
230              Comma separated zone map when fencing multiple plugs.
231
232       proxyhost
233              If a proxy is used for internet access, the proxy host should be
234              specified.
235
236       proxyport
237              If a proxy is used for internet access, the proxy port should be
238              specified.
239
240       earlyexit
241              If an existing reset operation is detected, the fence agent will
242              return  before  the  operation  completes  with a 0 return code.
243
244
245       warntimeout
246              If the operation is not completed within the timeout, the  clus‐
247              ter operations are allowed to continue.
248
249       errortimeout
250              If the operation is not completed within the timeout, cluster is
251              notified of the operation failure.
252
253       runonwarn
254              If a timeout would occur while running the agent, then the  sup‐
255              plied command is run.
256
257       runonfail
258              If  a failure would occur while running the agent, then the sup‐
259              plied command is run.
260
261       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
262              file or logging to syslog.
263
264       verbose
265              Verbose  mode.  Multiple  -v flags can be stacked on the command
266              line (e.g., -vvv) to increase verbosity.
267
268       verbose_level
269              Level of debugging detail in output. Defaults to the  number  of
270              --verbose  flags  specified on the command line, or to 1 if ver‐
271              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
272
273
274       debug_file
275              Write debug information to given file Obsoletes: debug
276
277       version
278              Display version information and exit
279
280       help   Display help and exit
281
282       plug_separator
283              Separator  for  plug  parameter when specifying more than 1 plug
284              (Default Value: ,)
285
286       separator
287              Separator for CSV created by 'list' operation (Default Value: ,)
288
289
290       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
291
292
293       disable_timeout
294              Disable timeout (true/false) (default: true when run from  Pace‐
295              maker 2.0+)
296
297       login_timeout
298              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
299
300
301       power_timeout
302              Test X seconds for status change after  ON/OFF  (Default  Value:
303              60)
304
305       power_wait
306              Wait X seconds after issuing ON/OFF (Default Value: 0)
307
308       shell_timeout
309              Wait  X  seconds  for  cmd prompt after issuing command (Default
310              Value: 3)
311
312       stonith_status_sleep
313              Sleep X seconds between status calls  during  a  STONITH  action
314              (Default Value: 1)
315
316       retry_on
317              Count of attempts to retry power on (Default Value: 1)
318
319
320
321fence_gce (Fence Agent)           2009-10-20                    FENCE_AGENT(8)