1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_aws - Fence agent for AWS (Amazon Web Services)
8

DESCRIPTION

10       fence_aws is an I/O Fencing agent for AWS (Amazon WebServices). It uses
11       the boto3 library to connect to AWS.
12
13       boto3 can be configured with AWS CLI or by creating ~/.aws/credentials.
14       For      instructions     see:     https://boto3.readthedocs.io/en/lat‐
15       est/guide/quickstart.html#configuration
16
17       fence_aws accepts options on the command line as well  as  from  stdin.
18       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
19       fence_aws can be run by itself with command line options.  This is use‐
20       ful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: http://www.amazon.com
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: reboot)
29
30       -n, --plug=[id]
31              Physical  plug  number  on device, UUID or identification of ma‐
32              chine This parameter is always required.
33
34       -r, --region=[region]
35              Region.
36
37       -a, --access-key=[key]
38              Access Key.
39
40       -s, --secret-key=[key]
41              Secret Key.
42
43       --filter=[key=value]
44              Filter for list-action
45
46       -b, --boto3_debug=[option]
47              Boto Lib debug (Default Value: False)
48
49       --skip-race-check
50              Skip race condition check
51
52       -q, --quiet
53              Disable logging to stderr. Does not affect --verbose or --debug-
54              file or logging to syslog.
55
56       -v, --verbose
57              Verbose  mode.  Multiple  -v flags can be stacked on the command
58              line (e.g., -vvv) to increase verbosity.
59
60       --verbose-level
61              Level of debugging detail in output. Defaults to the  number  of
62              --verbose  flags  specified on the command line, or to 1 if ver‐
63              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
64
65
66       -D, --debug-file=[debugfile]
67              Write debug information to given file
68
69       -V, --version
70              Display version information and exit
71
72       -h, --help
73              Display help and exit
74
75       --plug-separator=[char]
76              Separator  for  plug  parameter when specifying more than 1 plug
77              (Default Value: ,)
78
79       -C, --separator=[char]
80              Separator for CSV created by 'list' operation (Default Value: ,)
81
82
83       --delay=[seconds]
84              Wait  X  seconds  before  fencing  is started (Default Value: 0)
85
86
87       --disable-timeout=[true/false]
88              Disable timeout (true/false) (default: true when run from  Pace‐
89              maker 2.0+)
90
91       --login-timeout=[seconds]
92              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
93
94
95       --power-timeout=[seconds]
96              Test X seconds for status change after  ON/OFF  (Default  Value:
97              60)
98
99       --power-wait=[seconds]
100              Wait X seconds after issuing ON/OFF (Default Value: 0)
101
102       --shell-timeout=[seconds]
103              Wait  X  seconds  for  cmd prompt after issuing command (Default
104              Value: 3)
105
106       --stonith-status-sleep=[seconds]
107              Sleep X seconds between status calls  during  a  STONITH  action
108              (Default Value: 1)
109
110       --retry-on=[attempts]
111              Count of attempts to retry power on (Default Value: 1)
112
113

ACTIONS

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

STDIN PARAMETERS

147
148
149       action Fencing action (Default Value: reboot)
150
151       plug   Physical plug number on device, UUID or  identification  of  ma‐
152              chine  This  parameter is always required. Obsoletes: port
153
154
155       region Region.
156
157       access_key
158              Access Key.
159
160       secret_key
161              Secret Key.
162
163       filter Filter for list-action
164
165       boto3_debug
166              Boto Lib debug (Default Value: False)
167
168       skip_race_check
169              Skip race condition check
170
171       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
172              file or logging to syslog.
173
174       verbose
175              Verbose  mode.  Multiple  -v flags can be stacked on the command
176              line (e.g., -vvv) to increase verbosity.
177
178       verbose_level
179              Level of debugging detail in output. Defaults to the  number  of
180              --verbose  flags  specified on the command line, or to 1 if ver‐
181              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
182
183
184       debug_file
185              Write debug information to given file Obsoletes: debug
186
187       version
188              Display version information and exit
189
190       help   Display help and exit
191
192       plug_separator
193              Separator  for  plug  parameter when specifying more than 1 plug
194              (Default Value: ,)
195
196       separator
197              Separator for CSV created by 'list' operation (Default Value: ,)
198
199
200       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
201
202
203       disable_timeout
204              Disable timeout (true/false) (default: true when run from  Pace‐
205              maker 2.0+)
206
207       login_timeout
208              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
209
210
211       power_timeout
212              Test X seconds for status change after  ON/OFF  (Default  Value:
213              60)
214
215       power_wait
216              Wait X seconds after issuing ON/OFF (Default Value: 0)
217
218       shell_timeout
219              Wait  X  seconds  for  cmd prompt after issuing command (Default
220              Value: 3)
221
222       stonith_status_sleep
223              Sleep X seconds between status calls  during  a  STONITH  action
224              (Default Value: 1)
225
226       retry_on
227              Count of attempts to retry power on (Default Value: 1)
228
229
230
231fence_aws (Fence Agent)           2009-10-20                    FENCE_AGENT(8)