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

NAME

7       fence_apc - Fence agent for APC over telnet/ssh
8

DESCRIPTION

10       fence_apc  is  an I/O Fencing agent which can be used with the APC net‐
11       work power switch. It logs into device via telnet/ssh   and  reboots  a
12       specified  outlet.  Lengthy  telnet/ssh  connections  should be avoided
13       while a GFS cluster  is  running  because  the  connection  will  block
14       any necessary fencing actions.
15
16       fence_apc  accepts  options  on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_apc can be run by itself with command line options.  This is use‐
19       ful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://www.apc.com
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -c, --command-prompt=[prompt]
30              Force Python regex for  command  prompt  (Default  Value:  ['0',
31              '0pc>'])
32
33       -k, --identity-file=[filename]
34              Identity file (private key) for SSH
35
36       -4, --inet4-only
37              Forces agent to use IPv4 addresses only
38
39       -6, --inet6-only
40              Forces agent to use IPv6 addresses only
41
42       -a, --ip=[ip]
43              IP  address  or hostname of fencing device This parameter is al‐
44              ways required.
45
46       -u, --ipport=[port]
47              TCP/UDP port to use for connection with device  (Default  Value:
48              23)
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to run to retrieve password
55
56       -n, --plug=[id]
57              Physical  plug  number  on device, UUID or identification of ma‐
58              chine This parameter is always required.
59
60       -x, --ssh
61              Use SSH connection
62
63       --ssh-options=[options]
64              SSH options to use (Default Value: -1 -c blowfish)
65
66       -s, --switch=[id]
67              Physical switch number on device
68
69       -l, --username=[name]
70              Login name This parameter is always required.
71
72       -q, --quiet
73              Disable logging to stderr. Does not affect --verbose or --debug-
74              file or logging to syslog.
75
76       -v, --verbose
77              Verbose  mode.  Multiple  -v flags can be stacked on the command
78              line (e.g., -vvv) to increase verbosity.
79
80       --verbose-level
81              Level of debugging detail in output. Defaults to the  number  of
82              --verbose  flags  specified on the command line, or to 1 if ver‐
83              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
84
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       --plug-separator=[char]
96              Separator  for  plug  parameter when specifying more than 1 plug
97              (Default Value: ,)
98
99       -C, --separator=[char]
100              Separator for CSV created by 'list' operation (Default Value: ,)
101
102
103       --delay=[seconds]
104              Wait  X  seconds  before  fencing  is started (Default Value: 0)
105
106
107       --disable-timeout=[true/false]
108              Disable timeout (true/false) (default: true when run from  Pace‐
109              maker 2.0+)
110
111       --login-timeout=[seconds]
112              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
113
114
115       --power-timeout=[seconds]
116              Test X seconds for status change after  ON/OFF  (Default  Value:
117              20)
118
119       --power-wait=[seconds]
120              Wait X seconds after issuing ON/OFF (Default Value: 0)
121
122       --shell-timeout=[seconds]
123              Wait  X  seconds  for  cmd prompt after issuing command (Default
124              Value: 3)
125
126       --stonith-status-sleep=[seconds]
127              Sleep X seconds between status calls  during  a  STONITH  action
128              (Default Value: 1)
129
130       --retry-on=[attempts]
131              Count of attempts to retry power on (Default Value: 1)
132
133       --ssh-path=[path]
134              Path to ssh binary (Default Value: /usr/bin/ssh)
135
136       --telnet-path=[path]
137              Path to telnet binary (Default Value: /usr/bin/telnet)
138
139

ACTIONS

141
142
143       on     Power on machine.
144
145       off    Power off machine.
146
147       reboot Reboot machine.
148
149       status This returns the status of the plug/virtual machine.
150
151       list   List  available  plugs with aliases/virtual machines if there is
152              support for more then one device. Returns N/A otherwise.
153
154       list-status
155              List available plugs with  aliases/virtual  machines  and  their
156              power  state  if it can be obtained without additional commands.
157
158
159       monitor
160              Check the health of fence device
161
162       metadata
163              Display the XML metadata describing this resource.
164
165       manpage
166               The operational behavior of this is not known.
167
168       validate-all
169              Validate if all required parameters are entered.
170
171

STDIN PARAMETERS

173
174
175       action Fencing action (Default Value: reboot)
176
177       command_prompt
178              Force Python regex for  command  prompt  (Default  Value:  ['0',
179              '0pc>']) Obsoletes: cmd_prompt
180
181       identity_file
182              Identity file (private key) for SSH
183
184       inet4_only
185              Forces agent to use IPv4 addresses only
186
187       inet6_only
188              Forces agent to use IPv6 addresses only
189
190       ip     IP  address  or hostname of fencing device This parameter is al‐
191              ways required. Obsoletes: ipaddr
192
193       ipport TCP/UDP port to use for connection with device  (Default  Value:
194              23)
195
196       password
197              Login password or passphrase Obsoletes: passwd
198
199       password_script
200              Script  to  run  to  retrieve  password Obsoletes: passwd_script
201
202
203       plug   Physical plug number on device, UUID or  identification  of  ma‐
204              chine  This  parameter is always required. Obsoletes: port
205
206
207       ssh    Use SSH connection Obsoletes: secure
208
209       ssh_options
210              SSH options to use (Default Value: -1 -c blowfish)
211
212       switch Physical switch number on device
213
214       username
215              Login name This parameter is always required.  Obsoletes:  login
216
217
218       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
219              file or logging to syslog.
220
221       verbose
222              Verbose mode. Multiple -v flags can be stacked  on  the  command
223              line (e.g., -vvv) to increase verbosity.
224
225       verbose_level
226              Level  of  debugging detail in output. Defaults to the number of
227              --verbose flags specified on the command line, or to 1  if  ver‐
228              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
229
230
231       debug_file
232              Write debug information to given file Obsoletes: debug
233
234       version
235              Display version information and exit
236
237       help   Display help and exit
238
239       plug_separator
240              Separator for plug parameter when specifying more  than  1  plug
241              (Default Value: ,)
242
243       separator
244              Separator for CSV created by 'list' operation (Default Value: ,)
245
246
247       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
248
249
250       disable_timeout
251              Disable  timeout (true/false) (default: true when run from Pace‐
252              maker 2.0+)
253
254       login_timeout
255              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
256
257
258       power_timeout
259              Test  X  seconds  for status change after ON/OFF (Default Value:
260              20)
261
262       power_wait
263              Wait X seconds after issuing ON/OFF (Default Value: 0)
264
265       shell_timeout
266              Wait X seconds for cmd prompt  after  issuing  command  (Default
267              Value: 3)
268
269       stonith_status_sleep
270              Sleep  X  seconds  between  status calls during a STONITH action
271              (Default Value: 1)
272
273       retry_on
274              Count of attempts to retry power on (Default Value: 1)
275
276       ssh_path
277              Path to ssh binary (Default Value: /usr/bin/ssh)
278
279       telnet_path
280              Path to telnet binary (Default Value: /usr/bin/telnet)
281
282
283
284fence_apc (Fence Agent)           2009-10-20                    FENCE_AGENT(8)