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
13       application-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: onoff)
31
32       -n, --plug=[id]
33              Physical plug  number  on  device,  UUID  or  identification  of
34              machine 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.
54              (Default Value: 3)
55
56       --retrysleep=[seconds]
57              Time  to  sleep  in  seconds  between API retries, default is 5.
58              (Default Value: 5)
59
60       --serviceaccount=[filename]
61              Service Account to use for authentication to  the  google  cloud
62              APIs.
63
64       -q, --quiet
65              Disable logging to stderr. Does not affect --verbose or --debug-
66              file or logging to syslog.
67
68       -v, --verbose
69              Verbose mode. Multiple -v flags can be stacked  on  the  command
70              line (e.g., -vvv) to increase verbosity.
71
72       --verbose-level
73              Level  of  debugging detail in output. Defaults to the number of
74              --verbose flags specified on the command line, or to 1  if  ver‐
75              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
76
77
78       -D, --debug-file=[debugfile]
79              Write debug information to given file
80
81       -V, --version
82              Display version information and exit
83
84       -h, --help
85              Display help and exit
86
87       -C, --separator=[char]
88              Separator for CSV created by 'list' operation (Default Value: ,)
89
90
91       --delay=[seconds]
92              Wait  X  seconds  before  fencing  is started (Default Value: 0)
93
94
95       --disable-timeout=[true/false]
96              Disable timeout (true/false) (default: true when run from  Pace‐
97              maker 2.0+)
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              60)
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

ACTIONS

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

STDIN PARAMETERS

151
152
153       action Fencing action (Default Value: reboot)
154
155       method Method to fence (onoff|cycle) (Default Value: onoff)
156
157       plug   Physical  plug  number  on  device,  UUID  or  identification of
158              machine This parameter is always required. Obsoletes: port
159
160
161       zone   Zone.
162
163       project
164              Project ID.
165
166       stackdriver_logging
167              Stackdriver-logging   support.   Obsoletes:  stackdriver-logging
168
169
170       baremetalsolution
171              If enabled this is a bare metal offering from google.
172
173       apitimeout
174              Timeout in seconds to use for API calls, default is 60. (Default
175              Value: 60)
176
177       retries
178              Number  of  retries  on  failure  for  API  calls, default is 3.
179              (Default Value: 3)
180
181       retrysleep
182              Time to sleep in seconds between  API  retries,  default  is  5.
183              (Default Value: 5)
184
185       serviceaccount
186              Service  Account  to  use for authentication to the google cloud
187              APIs.
188
189       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
190              file or logging to syslog.
191
192       verbose
193              Verbose  mode.  Multiple  -v flags can be stacked on the command
194              line (e.g., -vvv) to increase verbosity.
195
196       verbose_level
197              Level of debugging detail in output. Defaults to the  number  of
198              --verbose  flags  specified on the command line, or to 1 if ver‐
199              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
200
201
202       debug_file
203              Write debug information to given file Obsoletes: debug
204
205       version
206              Display version information and exit
207
208       help   Display help and exit
209
210       separator
211              Separator for CSV created by 'list' operation (Default Value: ,)
212
213
214       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
215
216
217       disable_timeout
218              Disable  timeout (true/false) (default: true when run from Pace‐
219              maker 2.0+)
220
221       login_timeout
222              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
223
224
225       power_timeout
226              Test  X  seconds  for status change after ON/OFF (Default Value:
227              60)
228
229       power_wait
230              Wait X seconds after issuing ON/OFF (Default Value: 0)
231
232       shell_timeout
233              Wait X seconds for cmd prompt  after  issuing  command  (Default
234              Value: 3)
235
236       retry_on
237              Count of attempts to retry power on (Default Value: 1)
238
239
240
241fence_gce (Fence Agent)           2009-10-20                    FENCE_AGENT(8)