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

ACTIONS

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

STDIN PARAMETERS

119
120
121       action Fencing action (Default Value: reboot)
122
123       plug   Physical  plug  number  on  device,  UUID  or  identification of
124              machine This parameter is always required. Obsoletes: port
125
126
127       region Region.
128
129       access_key
130              Access Key.
131
132       secret_key
133              Secret Key.
134
135       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
136              file or logging to syslog.
137
138       verbose
139              Verbose mode
140
141       debug_file
142              Write debug information to given file Obsoletes: debug
143
144       version
145              Display version information and exit
146
147       help   Display help and exit
148
149       separator
150              Separator for CSV created by 'list' operation (Default Value: ,)
151
152
153       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
154
155
156       login_timeout
157              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
158
159
160       power_timeout
161              Test  X  seconds  for status change after ON/OFF (Default Value:
162              60)
163
164       power_wait
165              Wait X seconds after issuing ON/OFF (Default Value: 0)
166
167       shell_timeout
168              Wait X seconds for cmd prompt  after  issuing  command  (Default
169              Value: 3)
170
171       retry_on
172              Count of attempts to retry power on (Default Value: 1)
173
174
175
176fence_aws (Fence Agent)           2009-10-20                    FENCE_AGENT(8)
Impressum