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: cycle)
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       -q, --quiet
46              Disable logging to stderr. Does not affect --verbose or --debug-
47              file or logging to syslog.
48
49       -v, --verbose
50              Verbose mode
51
52       -D, --debug-file=[debugfile]
53              Write debug information to given file
54
55       -V, --version
56              Display version information and exit
57
58       -h, --help
59              Display help and exit
60
61       -C, --separator=[char]
62              Separator for CSV created by 'list' operation (Default Value: ,)
63
64
65       --delay=[seconds]
66              Wait  X  seconds  before  fencing  is started (Default Value: 0)
67
68
69       --login-timeout=[seconds]
70              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
71
72
73       --power-timeout=[seconds]
74              Test  X  seconds  for status change after ON/OFF (Default Value:
75              60)
76
77       --power-wait=[seconds]
78              Wait X seconds after issuing ON/OFF (Default Value: 0)
79
80       --shell-timeout=[seconds]
81              Wait X seconds for cmd prompt  after  issuing  command  (Default
82              Value: 3)
83
84       --retry-on=[attempts]
85              Count of attempts to retry power on (Default Value: 1)
86
87

ACTIONS

89
90
91       on     Power on machine.
92
93       off    Power off machine.
94
95       reboot Reboot machine.
96
97       status This returns the status of the plug/virtual machine.
98
99       list   List  available  plugs with aliases/virtual machines if there is
100              support for more then one device. Returns N/A otherwise.
101
102       list-status
103              List available plugs with  aliases/virtual  machines  and  their
104              power  state  if it can be obtained without additional commands.
105
106
107       monitor
108              Check the health of fence device
109
110       metadata
111              Display the XML metadata describing this resource.
112
113       manpage
114               The operational behavior of this is not known.
115
116       validate-all
117              Validate if all required parameters are entered.
118
119

STDIN PARAMETERS

121
122
123       action Fencing action (Default Value: reboot)
124
125       method Method to fence (onoff|cycle) (Default Value: cycle)
126
127       plug   Physical plug  number  on  device,  UUID  or  identification  of
128              machine This parameter is always required. Obsoletes: port
129
130
131       zone   Zone.
132
133       project
134              Project ID.
135
136       stackdriver_logging
137              Stackdriver-logging  support.   Obsoletes:   stackdriver-logging
138
139
140       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
141              file or logging to syslog.
142
143       verbose
144              Verbose mode
145
146       debug_file
147              Write debug information to given file Obsoletes: debug
148
149       version
150              Display version information and exit
151
152       help   Display help and exit
153
154       separator
155              Separator for CSV created by 'list' operation (Default Value: ,)
156
157
158       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
159
160
161       login_timeout
162              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
163
164
165       power_timeout
166              Test  X  seconds  for status change after ON/OFF (Default Value:
167              60)
168
169       power_wait
170              Wait X seconds after issuing ON/OFF (Default Value: 0)
171
172       shell_timeout
173              Wait X seconds for cmd prompt  after  issuing  command  (Default
174              Value: 3)
175
176       retry_on
177              Count of attempts to retry power on (Default Value: 1)
178
179
180
181fence_gce (Fence Agent)           2009-10-20                    FENCE_AGENT(8)