fence_aws(8)

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       -q, --quiet
50              Disable logging to stderr. Does not affect --verbose or --debug-
51              file or logging to syslog.
52
53       -v, --verbose
54              Verbose  mode.  Multiple  -v flags can be stacked on the command
55              line (e.g., -vvv) to increase verbosity.
56
57       --verbose-level
58              Level of debugging detail in output. Defaults to the  number  of
59              --verbose  flags  specified on the command line, or to 1 if ver‐
60              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
61
62
63       -D, --debug-file=[debugfile]
64              Write debug information to given file
65
66       -V, --version
67              Display version information and exit
68
69       -h, --help
70              Display help and exit
71
72       --plug-separator=[char]
73              Separator  for  plug  parameter when specifying more than 1 plug
74              (Default Value: ,)
75
76       -C, --separator=[char]
77              Separator for CSV created by 'list' operation (Default Value: ,)
78
79
80       --delay=[seconds]
81              Wait  X  seconds  before  fencing  is started (Default Value: 0)
82
83
84       --disable-timeout=[true/false]
85              Disable timeout (true/false) (default: true when run from  Pace‐
86              maker 2.0+)
87
88       --login-timeout=[seconds]
89              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
90
91
92       --power-timeout=[seconds]
93              Test X seconds for status change after  ON/OFF  (Default  Value:
94              60)
95
96       --power-wait=[seconds]
97              Wait X seconds after issuing ON/OFF (Default Value: 0)
98
99       --shell-timeout=[seconds]
100              Wait  X  seconds  for  cmd prompt after issuing command (Default
101              Value: 3)
102
103       --stonith-status-sleep=[seconds]
104              Sleep X seconds between status calls  during  a  STONITH  action
105              (Default Value: 1)
106
107       --retry-on=[attempts]
108              Count of attempts to retry power on (Default Value: 1)
109
110

ACTIONS

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

STDIN PARAMETERS

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