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

ACTIONS

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

STDIN PARAMETERS

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