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       -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. Multiple -v flags can be stacked  on  the  command
81              line (e.g., -vvv) to increase verbosity.
82
83       --verbose-level
84              Level  of  debugging detail in output. Defaults to the number of
85              --verbose flags specified on the command line, or to 1  if  ver‐
86              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
87
88
89       -D, --debug-file=[debugfile]
90              Write debug information to given file
91
92       -V, --version
93              Display version information and exit
94
95       -h, --help
96              Display help and exit
97
98       -C, --separator=[char]
99              Separator for CSV created by 'list' operation (Default Value: ,)
100
101
102       --delay=[seconds]
103              Wait  X  seconds  before  fencing  is started (Default Value: 0)
104
105
106       --disable-timeout=[true/false]
107              Disable timeout (true/false) (default: true when run from  Pace‐
108              maker 2.0+)
109
110       --login-timeout=[seconds]
111              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
112
113
114       --power-timeout=[seconds]
115              Test X seconds for status change after  ON/OFF  (Default  Value:
116              60)
117
118       --power-wait=[seconds]
119              Wait X seconds after issuing ON/OFF (Default Value: 0)
120
121       --shell-timeout=[seconds]
122              Wait  X  seconds  for  cmd prompt after issuing command (Default
123              Value: 3)
124
125       --stonith-status-sleep=[seconds]
126              Sleep X seconds between status calls  during  a  STONITH  action
127              (Default Value: 1)
128
129       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132

ACTIONS

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

STDIN PARAMETERS

166
167
168       action Fencing action (Default Value: reboot)
169
170       method Method to fence (onoff|cycle) (Default Value: cycle)
171
172       plug   Physical plug number on device, UUID or  identification  of  ma‐
173              chine  This  parameter is always required. Obsoletes: port
174
175
176       zone   Zone.
177
178       project
179              Project ID.
180
181       stackdriver_logging
182              Stackdriver-logging  support.   Obsoletes:   stackdriver-logging
183
184
185       baremetalsolution
186              If enabled this is a bare metal offering from google.
187
188       apitimeout
189              Timeout in seconds to use for API calls, default is 60. (Default
190              Value: 60)
191
192       retries
193              Number of retries on failure for API calls, default is  3.  (De‐
194              fault Value: 3)
195
196       retrysleep
197              Time to sleep in seconds between API retries, default is 5. (De‐
198              fault Value: 5)
199
200       serviceaccount
201              Service Account to use for authentication to  the  google  cloud
202              APIs.
203
204       plugzonemap
205              Comma separated zone map when fencing multiple plugs.
206
207       proxyhost
208              If a proxy is used for internet access, the proxy host should be
209              specified.
210
211       proxyport
212              If a proxy is used for internet access, the proxy port should be
213              specified.
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose mode. Multiple -v flags can be stacked  on  the  command
220              line (e.g., -vvv) to increase verbosity.
221
222       verbose_level
223              Level  of  debugging detail in output. Defaults to the number of
224              --verbose flags specified on the command line, or to 1  if  ver‐
225              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
226
227
228       debug_file
229              Write debug information to given file Obsoletes: debug
230
231       version
232              Display version information and exit
233
234       help   Display help and exit
235
236       separator
237              Separator for CSV created by 'list' operation (Default Value: ,)
238
239
240       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
241
242
243       disable_timeout
244              Disable timeout (true/false) (default: true when run from  Pace‐
245              maker 2.0+)
246
247       login_timeout
248              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
249
250
251       power_timeout
252              Test X seconds for status change after  ON/OFF  (Default  Value:
253              60)
254
255       power_wait
256              Wait X seconds after issuing ON/OFF (Default Value: 0)
257
258       shell_timeout
259              Wait  X  seconds  for  cmd prompt after issuing command (Default
260              Value: 3)
261
262       stonith_status_sleep
263              Sleep X seconds between status calls  during  a  STONITH  action
264              (Default Value: 1)
265
266       retry_on
267              Count of attempts to retry power on (Default Value: 1)
268
269
270
271fence_gce (Fence Agent)           2009-10-20                    FENCE_AGENT(8)