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       -C, --separator=[char]
73              Separator for CSV created by 'list' operation (Default Value: ,)
74
75
76       --delay=[seconds]
77              Wait X seconds before fencing  is  started  (Default  Value:  0)
78
79
80       --disable-timeout=[true/false]
81              Disable  timeout (true/false) (default: true when run from Pace‐
82              maker 2.0+)
83
84       --login-timeout=[seconds]
85              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
86
87
88       --power-timeout=[seconds]
89              Test  X  seconds  for status change after ON/OFF (Default Value:
90              60)
91
92       --power-wait=[seconds]
93              Wait X seconds after issuing ON/OFF (Default Value: 0)
94
95       --shell-timeout=[seconds]
96              Wait X seconds for cmd prompt  after  issuing  command  (Default
97              Value: 3)
98
99       --stonith-status-sleep=[seconds]
100              Sleep  X  seconds  between  status calls during a STONITH action
101              (Default Value: 1)
102
103       --retry-on=[attempts]
104              Count of attempts to retry power on (Default Value: 1)
105
106

ACTIONS

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

STDIN PARAMETERS

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