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       --proxyhost=[proxy_host]
65              If a proxy is used for internet access, the proxy host should be
66              specified.
67
68       --proxyport=[proxy_port]
69              If a proxy is used for internet access, the proxy port should be
70              specified.
71
72       -q, --quiet
73              Disable logging to stderr. Does not affect --verbose or --debug-
74              file or logging to syslog.
75
76       -v, --verbose
77              Verbose mode. Multiple -v flags can be stacked  on  the  command
78              line (e.g., -vvv) to increase verbosity.
79
80       --verbose-level
81              Level  of  debugging detail in output. Defaults to the number of
82              --verbose flags specified on the command line, or to 1  if  ver‐
83              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
84
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait  X  seconds  before  fencing  is started (Default Value: 0)
101
102
103       --disable-timeout=[true/false]
104              Disable timeout (true/false) (default: true when run from  Pace‐
105              maker 2.0+)
106
107       --login-timeout=[seconds]
108              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
109
110
111       --power-timeout=[seconds]
112              Test X seconds for status change after  ON/OFF  (Default  Value:
113              60)
114
115       --power-wait=[seconds]
116              Wait X seconds after issuing ON/OFF (Default Value: 0)
117
118       --shell-timeout=[seconds]
119              Wait  X  seconds  for  cmd prompt after issuing command (Default
120              Value: 3)
121
122       --stonith-status-sleep=[seconds]
123              Sleep X seconds between status calls  during  a  STONITH  action
124              (Default Value: 1)
125
126       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
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       method Method to fence (onoff|cycle) (Default Value: cycle)
168
169       plug   Physical plug number on device, UUID or  identification  of  ma‐
170              chine  This  parameter is always required. Obsoletes: port
171
172
173       zone   Zone.
174
175       project
176              Project ID.
177
178       stackdriver_logging
179              Stackdriver-logging  support.   Obsoletes:   stackdriver-logging
180
181
182       baremetalsolution
183              If enabled this is a bare metal offering from google.
184
185       apitimeout
186              Timeout in seconds to use for API calls, default is 60. (Default
187              Value: 60)
188
189       retries
190              Number of retries on failure for API calls, default is  3.  (De‐
191              fault Value: 3)
192
193       retrysleep
194              Time to sleep in seconds between API retries, default is 5. (De‐
195              fault Value: 5)
196
197       serviceaccount
198              Service Account to use for authentication to  the  google  cloud
199              APIs.
200
201       proxyhost
202              If a proxy is used for internet access, the proxy host should be
203              specified.
204
205       proxyport
206              If a proxy is used for internet access, the proxy port should be
207              specified.
208
209       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
210              file or logging to syslog.
211
212       verbose
213              Verbose mode. Multiple -v flags can be stacked  on  the  command
214              line (e.g., -vvv) to increase verbosity.
215
216       verbose_level
217              Level  of  debugging detail in output. Defaults to the number of
218              --verbose flags specified on the command line, or to 1  if  ver‐
219              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
220
221
222       debug_file
223              Write debug information to given file Obsoletes: debug
224
225       version
226              Display version information and exit
227
228       help   Display help and exit
229
230       separator
231              Separator for CSV created by 'list' operation (Default Value: ,)
232
233
234       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
235
236
237       disable_timeout
238              Disable timeout (true/false) (default: true when run from  Pace‐
239              maker 2.0+)
240
241       login_timeout
242              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
243
244
245       power_timeout
246              Test X seconds for status change after  ON/OFF  (Default  Value:
247              60)
248
249       power_wait
250              Wait X seconds after issuing ON/OFF (Default Value: 0)
251
252       shell_timeout
253              Wait  X  seconds  for  cmd prompt after issuing command (Default
254              Value: 3)
255
256       stonith_status_sleep
257              Sleep X seconds between status calls  during  a  STONITH  action
258              (Default Value: 1)
259
260       retry_on
261              Count of attempts to retry power on (Default Value: 1)
262
263
264
265fence_gce (Fence Agent)           2009-10-20                    FENCE_AGENT(8)