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
32              machine 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       -b, --boto3_debug=[option]
44              Boto Lib debug (Default Value: False)
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.  Multiple  -v flags can be stacked on the command
52              line (e.g., -vvv) to increase verbosity.
53
54       --verbose-level
55              Level of debugging detail in output. Defaults to the  number  of
56              --verbose  flags  specified on the command line, or to 1 if ver‐
57              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
58
59
60       -D, --debug-file=[debugfile]
61              Write debug information to given file
62
63       -V, --version
64              Display version information and exit
65
66       -h, --help
67              Display help and exit
68
69       -C, --separator=[char]
70              Separator for CSV created by 'list' operation (Default Value: ,)
71
72
73       --delay=[seconds]
74              Wait X seconds before fencing  is  started  (Default  Value:  0)
75
76
77       --disable-timeout=[true/false]
78              Disable  timeout (true/false) (default: true when run from Pace‐
79              maker 2.0+)
80
81       --login-timeout=[seconds]
82              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
83
84
85       --power-timeout=[seconds]
86              Test  X  seconds  for status change after ON/OFF (Default Value:
87              60)
88
89       --power-wait=[seconds]
90              Wait X seconds after issuing ON/OFF (Default Value: 0)
91
92       --shell-timeout=[seconds]
93              Wait X seconds for cmd prompt  after  issuing  command  (Default
94              Value: 3)
95
96       --retry-on=[attempts]
97              Count of attempts to retry power on (Default Value: 1)
98
99

ACTIONS

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

STDIN PARAMETERS

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